org.lsst.ccs.framework

Interface Configurable.Environment

All Known Implementing Classes:

ComponentConfigurationEnvironment

Enclosing interface:

Configurable

Deprecated.

Use ComponentConfigurationEnvironment instead

@Deprecated
public static interface Configurable.Environment

instances of this class are created by the subsystem startup. They operate delegations on behalf of the Configurable Object. The Configurable Object can thus access its ConfigurationProxy and its ComponentLookup

Method Summary

Modifier and Type	Method and Description
void	change(String parameterName, Object value) Deprecated. Use ComponentConfigurationEnvironment instead
void	dropAllChanges() Deprecated. Use ComponentConfigurationEnvironment instead
void	dropBulkChange() Deprecated.
void	dropChangesForCategories(String... categories) Deprecated. Use ComponentConfigurationEnvironment instead
default <T> LinkedHashMap<String,T>	getChildren(Class<T> classFilter) Deprecated. use getComponentLookup() from Subsystem instead
default Object	getComponentByName(String name) Deprecated. use getComponentLookup() from Subsystem instead
default String	getNameOfComponent() Deprecated. use getComponentLookup() from Subsystem instead
default Map.Entry<String,Object>	getParent() Deprecated. use getComponentLookup() from Subsystem instead
Map<String,String>	getSubmittedChanges() Deprecated.
default Optional<Subsystem>	getSubsystem() Deprecated. Use Subsystem.getSubsystemForObject(this) instead.
Boolean	isParameterConfigurable(String parameterName) Deprecated.
Map<String,String>	printConfigurableParameters(String[] categories) Deprecated.
void	saveAllChanges() Deprecated. Use ComponentConfigurationEnvironment instead
void	saveChangesForCategories(String... categories) Deprecated. Use ComponentConfigurationEnvironment instead
void	saveChangesForCategoriesAs(String... taggedCategories) Deprecated. Use ComponentConfigurationEnvironment instead
void	submitChange(String parameterName, Object value) Deprecated.

Method Detail

change

@Deprecated
void change(String parameterName,
                        Object value)

Deprecated. Use ComponentConfigurationEnvironment instead

performs a parameter change during an engineering session

Parameters:

parameterName - name of parameter for the current object.

value - any object that is fit for the configuration system (see documentation)

Throws:

IllegalArgumentException - if parameter has a name unknown to the configuration

submitChange

@Deprecated
void submitChange(String parameterName,
                              Object value)

Deprecated.

saveAllChanges

@Deprecated
void saveAllChanges()

Deprecated. Use ComponentConfigurationEnvironment instead

Saves all changes in their current configuration.

Throws:

ConfigurationServiceException

saveChangesForCategories

@Deprecated
void saveChangesForCategories(String... categories)

Deprecated. Use ComponentConfigurationEnvironment instead

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.

Parameters:

categories - a list of categories

Throws:

ConfigurationServiceException

saveChangesForCategoriesAs

@Deprecated
void saveChangesForCategoriesAs(String... taggedCategories)

Deprecated. Use ComponentConfigurationEnvironment instead

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.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

dropAllChanges

@Deprecated
void dropAllChanges()

Deprecated. Use ComponentConfigurationEnvironment instead

All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category. The configuration context is no longer active.

dropChangesForCategories

@Deprecated
void dropChangesForCategories(String... categories)

Deprecated. Use ComponentConfigurationEnvironment instead

Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched. The configuration context remains active.

Parameters:

categories - A list of categories

isParameterConfigurable

@Deprecated
Boolean isParameterConfigurable(String parameterName)

Deprecated.

dropBulkChange

@Deprecated
void dropBulkChange()

Deprecated.

printConfigurableParameters

@Deprecated
Map<String,String> printConfigurableParameters(String[] categories)

Deprecated.

returns the current values for configurable parameters of this component that belong to the given categories.

Parameters:

categories -

Returns:

getSubmittedChanges

@Deprecated
Map<String,String> getSubmittedChanges()

Deprecated.

getSubsystem

@Deprecated
default Optional<Subsystem> getSubsystem()

Deprecated. Use Subsystem.getSubsystemForObject(this) instead.

getComponentByName

@Deprecated
default Object getComponentByName(String name)

Deprecated. use getComponentLookup() from Subsystem instead

request a Component from a Description by its name.

Parameters:

name -

Returns:

A Component. beware unless you are dead sure do not assume this component is a Configurable object (any object can be aliased and so put in the dictionary)

getChildren

@Deprecated
default <T> LinkedHashMap<String,T> getChildren(Class<T> classFilter)

Deprecated. use getComponentLookup() from Subsystem instead

get the children of the Configurable object that are assignable to an instance of the class argument.

Type Parameters:

T -

Parameters:

classFilter - if null, no class filtering is applied.

Returns:

a map of components mapped by their name.

getParent

@Deprecated
default Map.Entry<String,Object> getParent()

Deprecated. use getComponentLookup() from Subsystem instead

returns the parent of the current component

Returns:

the Component (value) and its name (key) null if there is no parent.

getNameOfComponent

@Deprecated
default String getNameOfComponent()

Deprecated. use getComponentLookup() from Subsystem instead

Returns:

the name associated with this component