public class ALPreferenceManager extends ALProxy
Constructor and Description |
---|
ALPreferenceManager(Session session) |
Modifier and Type | Method and Description |
---|---|
void |
clearStats() |
void |
exit()
Exits and unregisters the module.
|
java.lang.String |
getBrokerName()
Gets the name of the parent broker.
|
java.util.List<java.lang.String> |
getDomainList()
Get available preferences domain
|
java.lang.Object |
getMethodHelp(java.lang.String methodName)
Retrieves a method's description.
|
java.util.List<java.lang.String> |
getMethodList()
Retrieves the module's method list.
|
java.lang.Object |
getModuleHelp()
Retrieves the module's description.
|
java.lang.String |
getUsage(java.lang.String name)
Gets the method usage string.
|
java.lang.Object |
getValue(java.lang.String domain,
java.lang.String setting)
Get specified preference
|
java.util.List<java.util.List<java.lang.Object>> |
getValueList(java.lang.String domain)
Get preferences names and values for a given domain
|
void |
importPrefFile(java.lang.String domain,
java.lang.String applicationName,
java.lang.String filename,
java.lang.Boolean override)
Import a preferences XML file
|
java.lang.Boolean |
isRunning(java.lang.Integer id)
Returns true if the method is currently running.
|
java.lang.Boolean |
isStatsEnabled() |
java.lang.Boolean |
isTraceEnabled() |
java.lang.Boolean |
ping()
Just a ping.
|
void |
removeDomainValues(java.lang.String domain)
Remove an entire preference domain
|
void |
removeValue(java.lang.String domain,
java.lang.String setting)
Remove specified preference
|
void |
setValue(java.lang.String domain,
java.lang.String setting,
java.lang.Object value)
Set specified preference
|
void |
stop(java.lang.Integer id)
returns true if the method is currently running
|
void |
update()
Synchronizes local preferences with preferences stored on a server.
|
java.lang.String |
version()
Returns the version of the module.
|
java.lang.Boolean |
wait(java.lang.Integer id,
java.lang.Integer timeoutPeriod)
Wait for the end of a long running method that was called using 'post'
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public ALPreferenceManager(Session session) throws java.lang.Exception
java.lang.Exception
public java.lang.Boolean isStatsEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void clearStats() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isTraceEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void exit() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String version() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean ping() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getMethodList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object getMethodHelp(java.lang.String methodName) throws CallError, java.lang.InterruptedException
methodName
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object getModuleHelp() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) throws CallError, java.lang.InterruptedException
id
- The ID of the method that was returned when calling the method using 'post'timeoutPeriod
- The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.CallError
java.lang.InterruptedException
public java.lang.Boolean isRunning(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- The ID of the method that was returned when calling the method using 'post'CallError
java.lang.InterruptedException
public void stop(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- the ID of the method to wait forCallError
java.lang.InterruptedException
public java.lang.String getBrokerName() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String getUsage(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object getValue(java.lang.String domain, java.lang.String setting) throws CallError, java.lang.InterruptedException
domain
- Preference domainsetting
- Preference settingCallError
java.lang.InterruptedException
public void setValue(java.lang.String domain, java.lang.String setting, java.lang.Object value) throws CallError, java.lang.InterruptedException
domain
- Preference domainsetting
- Preference settingvalue
- Preference valueCallError
java.lang.InterruptedException
public java.util.List<java.util.List<java.lang.Object>> getValueList(java.lang.String domain) throws CallError, java.lang.InterruptedException
domain
- Preference domainCallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getDomainList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void removeValue(java.lang.String domain, java.lang.String setting) throws CallError, java.lang.InterruptedException
domain
- Preference domainsetting
- Preference settingCallError
java.lang.InterruptedException
public void removeDomainValues(java.lang.String domain) throws CallError, java.lang.InterruptedException
domain
- Preference domainCallError
java.lang.InterruptedException
public void importPrefFile(java.lang.String domain, java.lang.String applicationName, java.lang.String filename, java.lang.Boolean override) throws CallError, java.lang.InterruptedException
domain
- Preference domain: all preferences values found in XML file will be imported in that domain.applicationName
- Application name: will be used to search for preference file on disk (in location of type filename
- Preference XML filenameoverride
- Set this to true if you want to override preferences that already exist with preferences in imported XML fileCallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.