org.lsst.ccs.config

Class ParameterConfiguration

java.lang.Object

org.lsst.ccs.config.ParameterConfiguration

All Implemented Interfaces:

Serializable, PathObject

@MappedSuperclass
public abstract class ParameterConfiguration
extends Object
implements Serializable, PathObject

abstract class for all parameter configurations

Author:

bamade

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changingStaticData tells us if this configuration can be operated at runTime or not
protected String	configuredValue This is the configured value corresponding to the current configuration for this parameter
protected Exception	reConfigurationFailure this transient field is to carry information about a failure in configuration "repair".

Fields inherited from interface org.lsst.ccs.config.PathObject

COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParameterConfiguration()
protected	ParameterConfiguration(String value)

Method Summary

Modifier and Type	Method and Description
protected Object	checkValue(String value)
boolean	equals(Object o)
String	getConfiguredValue() Returns the configured value for this parameter
abstract ParameterDescription	getDescription()
abstract long	getId()
ParameterPath	getPath()
Exception	getReConfigurationFailure()
String	getValueAt(long date)
abstract List<? extends ValueEvent>	getValueEvents()
boolean	hasChanged()
int	hashCode()
boolean	isChangingStaticData()
boolean	isReadOnly()
void	modifyValue(String value, boolean checkValue) Modifies the configuredValue field
protected abstract void	setId(long id)
void	setReConfigurationFailure(Exception reConfigurationFail)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

configuredValue

protected String configuredValue

This is the configured value corresponding to the current configuration for this parameter

changingStaticData

protected boolean changingStaticData

tells us if this configuration can be operated at runTime or not

reConfigurationFailure

protected Exception reConfigurationFailure

this transient field is to carry information about a failure in configuration "repair". The corresponding parameter cannot be matched to a new SubsystemDescription to which we try to attach this (possibly deprecated) Configuration.

Constructor Detail

ParameterConfiguration

protected ParameterConfiguration()

ParameterConfiguration

protected ParameterConfiguration(String value)

Method Detail

getId

public abstract long getId()

setId

protected abstract void setId(long id)

isReadOnly

public boolean isReadOnly()

getReConfigurationFailure

public Exception getReConfigurationFailure()

setReConfigurationFailure

public void setReConfigurationFailure(Exception reConfigurationFail)

getDescription

public abstract ParameterDescription getDescription()

getValueEvents

public abstract List<? extends ValueEvent> getValueEvents()

getConfiguredValue

public String getConfiguredValue()

Returns the configured value for this parameter

Returns:

getValueAt

public String getValueAt(long date)

isChangingStaticData

public boolean isChangingStaticData()

checkValue

protected Object checkValue(String value)
                     throws IllegalArgumentException

Throws:

IllegalArgumentException

modifyValue

public void modifyValue(String value,
                        boolean checkValue)

Modifies the configuredValue field

Parameters:

value -

checkValue - if true, the value is checked for consistency against the constraints

Throws:

ImmutableStateException - if modification is for a registered object

IllegalArgumentException - if value is not coherent with type and constraints

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPath

public ParameterPath getPath()

Specified by:

getPath in interface PathObject

hasChanged

public boolean hasChanged()