
public static class Configurable.Environment extends Object
| Constructor and Description |
|---|
Environment(String name,
Configurable currentObject,
ConfigurationProxy configurationProxy,
ComponentLookupService lookupService)
Creates an Environment for a Configurable object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
alias(String name) |
void |
change(String parameterName,
Object value)
performs a parameter change during an agineering session
|
void |
dropConfigurationContext()
drops context of parameter modification (returns to previous Configuration values)
|
ViewValue |
getCheckedValueFromConfiguration(String parameterName,
Object value)
Checks if a value can be accepted by the Configuration system.
|
<T> LinkedHashMap<String,T> |
getChildren(Class<T> classFilter)
get the "children" of the current component.
|
LocalCommandDictionary |
getCommandBuilder() |
Object |
getComponentByName(String name)
request a Component from a Description by its name.
|
Map<String,Method> |
getConfigMethodsOfComponent() |
Dictionary |
getDictionary() |
String |
getNameOfComponent() |
Map.Entry<String,Object> |
getParent()
returns the parent of the current component
|
Object |
getRelevantObject() |
Optional<Subsystem> |
getSubsystem() |
List<Configurable> |
listChildren()
gets the children of this Object
|
void |
newConfigurationContext()
Deprecated.
will be neutralized in 2.0 and 2.1 branches
|
protected void |
notifyChange(String parameterName,
String value)
to be used by "facade" commands that may set a value
the calling must have made a preliminary check with the configuration service. |
void |
notifyChangeWithoutPreliminaryChecks(String parameterName,
Object value)
to be used by "facade" commands that may set a value
then notify the configuration without going through the preliminary check
of the configuration service.
|
void |
register(String configurationName)
Deprecated.
Use saveConfiguration(configurationName) instead
|
void |
register(String configurationName,
String tag)
Deprecated.
|
void |
saveConfiguration()
Saves the current Configuration .
|
void |
saveConfiguration(String configurationName)
Saves a configuration with a new name.
|
public Environment(String name, Configurable currentObject, ConfigurationProxy configurationProxy, ComponentLookupService lookupService)
name - currentObject - configurationProxy - lookupService - @Deprecated public void newConfigurationContext()
public void change(String parameterName, Object value) throws Exception
parameterName - name of parameter for the current object.value - any object that is fit for the configuration system (see documentation)IllegalArgumentException - if parameter has a name unknown to the configurationException - that can be thrown by the ConfigurationProxy
(no connection, illegal format, constraints failure) or by the user's code
(preconditions)@Deprecated public void register(String configurationName, String tag) throws IOException
configurationName - tag - IOException@Deprecated public void register(String configurationName) throws IOException
configurationName - IOExceptionpublic void saveConfiguration()
throws IOException
IOExceptionpublic void saveConfiguration(String configurationName) throws IOException
configurationName - IOExceptionpublic void dropConfigurationContext()
public ViewValue getCheckedValueFromConfiguration(String parameterName, Object value) throws Exception
parameterName - value - can be a real Object or its String representationExceptionpublic void notifyChangeWithoutPreliminaryChecks(String parameterName, Object value) throws Exception
parameterName - value - Exceptionprotected void notifyChange(String parameterName, String value) throws Exception
parameterName - value - Exceptionpublic Object getComponentByName(String name)
name - public void alias(String name)
public <T> LinkedHashMap<String,T> getChildren(Class<T> classFilter)
T - classFilter - public List<Configurable> listChildren()
public Map.Entry<String,Object> getParent()
public String getNameOfComponent()
public Object getRelevantObject()
public LocalCommandDictionary getCommandBuilder()
public Dictionary getDictionary()
Copyright © 2015 LSST. All rights reserved.