org.lsst.ccs.bus.data

Class ConfigurationParameterInfo

java.lang.Object

org.lsst.ccs.bus.data.ConfigurationParameterInfo

All Implemented Interfaces:

Serializable

public class ConfigurationParameterInfo
extends Object
implements Serializable

Represents the state of a given parameter.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurationParameterInfo(String pathName, String categoryName, String type, boolean isFinal, String configuredValue, String currentValue, boolean dirty, String description)
ConfigurationParameterInfo(String pathName, String categoryName, String type, String configuredValue, String currentValue, boolean dirty, String description) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getCategoryName() The category the parameter belongs to.
String	getComponentName() Returns the name of the component the parameter represented by this object belongs to.
String	getConfiguredValue() The configured value for this parameter, i.e the value defined by the last configuration loading.
String	getCurrentValue() The current value for this parameter.
String	getDescription()
String	getParameterName() Returns the name of the parameter represented by this object.
String	getPathName() The Path name of the parameter.
String	getType() Return the type of the parameter.
boolean	isDirty() Boolean indicating if this parameter has been changed to a value and has not been saved yet.
boolean	isFinal()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationParameterInfo

public ConfigurationParameterInfo(String pathName,
                                  String categoryName,
                                  String type,
                                  boolean isFinal,
                                  String configuredValue,
                                  String currentValue,
                                  boolean dirty,
                                  String description)

ConfigurationParameterInfo

@Deprecated
public ConfigurationParameterInfo(String pathName,
                                              String categoryName,
                                              String type,
                                              String configuredValue,
                                              String currentValue,
                                              boolean dirty,
                                              String description)

Deprecated.

Method Detail

getPathName

public String getPathName()

The Path name of the parameter. e.g : "main//TickMillis"

Returns:

a String representation of the path name

getComponentName

public String getComponentName()

Returns the name of the component the parameter represented by this object belongs to.

Returns:

the component name

getParameterName

public String getParameterName()

Returns the name of the parameter represented by this object.

Returns:

the parameter name

getCategoryName

public String getCategoryName()

The category the parameter belongs to.

Returns:

the category the parameter represented by this object belongs to

getConfiguredValue

public String getConfiguredValue()

The configured value for this parameter, i.e the value defined by the last configuration loading.

Returns:

a String representation of the configured value.

getCurrentValue

public String getCurrentValue()

The current value for this parameter.

Returns:

a String representation of the current value assigned to the parameter

isDirty

public boolean isDirty()

Boolean indicating if this parameter has been changed to a value and has not been saved yet.

Returns:

True if the current value does not match the configured value.

getDescription

public String getDescription()

Returns:

The parameter's short description.

getType

public String getType()

Return the type of the parameter.

Returns:

isFinal

public boolean isFinal()

toString

public String toString()

Overrides:

toString in class Object