
public static interface Configurable.Environment
| Modifier and Type | Method and Description |
|---|---|
void |
change(String parameterName,
Object value)
performs a parameter change during an engineering session
|
void |
dropAllChanges()
All unsaved changes are dropped, each parameter goes back to the value specified
by the current configuration for this category.
|
void |
dropBulkChange() |
void |
dropChangesForCategories(String... categories)
Changes occurring for one of the mentioned categories in categories are dropped,
other categories are left untouched.
|
ViewValue |
getCheckedValueFromConfiguration(String parameterName,
Object value)
Deprecated.
use isParameterConfigurable(String parameterName) instead
|
<T> LinkedHashMap<String,T> |
getChildren(Class<T> classFilter)
get the children of the
Configurable object that are assignable
to an instance of the class argument. |
Object |
getComponentByName(String name)
request a Component from a Description by its name.
|
TreeBranch<String> |
getComponentTree()
Returns a tree of component names starting from the current component
|
String |
getNameOfComponent() |
Map.Entry<String,Object> |
getParent()
returns the parent of the current component
|
Map<String,String> |
getSubmittedChanges() |
Optional<Subsystem> |
getSubsystem() |
Boolean |
isParameterConfigurable(String parameterName) |
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.
|
Map<String,String> |
printConfigurableParameters(String[] categories)
returns the current values for configurable parameters of this component
that belong to the given categories.
|
void |
saveAllChanges()
Saves all changes in their current configuration.
|
void |
saveChangesForCategories(String... categories)
Changes made in the specified categories are saved under the current configuration
for this category, changes on parameters that belong to other categories
are left unchanged.
|
void |
saveChangesForCategoriesAs(String... taggedCategories)
Changes made in the specified categories are saved under the newly specified
name for this category, changes on parameters that belong to other categories
are left unchanged.
|
void |
sendSignal(Signal signal)
Sends a signal starting from the current component
|
void |
submitChange(String parameterName,
Object value) |
void change(String parameterName, Object value)
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 configurationvoid saveAllChanges()
ConfigurationServiceExceptionvoid saveChangesForCategories(String... categories)
categories - a list of categoriesConfigurationServiceExceptionvoid saveChangesForCategoriesAs(String... taggedCategories)
taggedCategories - a list of pairs categoryName:configurationNameConfigurationServiceExceptionvoid dropAllChanges()
void dropChangesForCategories(String... categories)
categories - A list of categories@Deprecated ViewValue getCheckedValueFromConfiguration(String parameterName, Object value) throws Exception
parameterName - value - can be a real Object or its String representationExceptionvoid notifyChangeWithoutPreliminaryChecks(String parameterName, Object value)
parameterName - value - void notifyChange(String parameterName, String value)
parameterName - value - Object getComponentByName(String name)
name - <T> LinkedHashMap<String,T> getChildren(Class<T> classFilter)
Configurable object that are assignable
to an instance of the class argument.T - classFilter - if null, no class filtering is applied.Map.Entry<String,Object> getParent()
String getNameOfComponent()
void dropBulkChange()
TreeBranch<String> getComponentTree()
void sendSignal(Signal signal)
signal - Map<String,String> printConfigurableParameters(String[] categories)
categories - Copyright © 2016 LSST. All rights reserved.