org.lsst.ccs.config

Class ParameterPath

java.lang.Object

org.lsst.ccs.config.ParameterPath

All Implemented Interfaces:

Serializable, Comparable<PathObject>, PathObject

@Embeddable
public class ParameterPath
extends Object
implements PathObject, Serializable

Unique Path in a SubSystem. Objects of this class are immutable. (no public mutator).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterPath(String componentName, String codeName, String parameterName) "real" constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCodeName()
String	getComponentName()
String	getParameterName()
ParameterPath	getPath()
int	hashCode()
String	toString()
static ParameterPath	valueOf(String pathString) reverse operation from toString(): creates a ParameterPath from a String.

Methods inherited from class java.lang.Object

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

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

compareTo

Constructor Detail

ParameterPath

public ParameterPath(String componentName,
                     String codeName,
                     String parameterName)

"real" constructor

Parameters:

componentName - should not be null

codeName - null of empty means constructor

parameterName - should not be null

Method Detail

getComponentName

public String getComponentName()

getCodeName

public String getCodeName()

getParameterName

public String getParameterName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static ParameterPath valueOf(String pathString)

reverse operation from toString(): creates a ParameterPath from a String.

Parameters:

pathString - should be of the form "componentName/codeName/parameterName" (example: "carousel//tickMillis")

Returns:

a ParameterPath out of the given path String

Throws:

IllegalArgumentException - if format is not correct

getPath

public ParameterPath getPath()

Specified by:

getPath in interface PathObject