org.lsst.ccs.utilities.structs

Class ParameterPath

java.lang.Object

org.lsst.ccs.utilities.structs.ParameterPath

All Implemented Interfaces:

Serializable, Comparable

public class ParameterPath
extends Object
implements Serializable, Comparable

Path of a configuration parameter.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterPath(String componentName, String parameterName)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
boolean	equals(Object o)
String	getComponentName() Gets the component this parameter belongs to.
String	getParameterName() Gets the parameter name.
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

Constructor Detail

ParameterPath

public ParameterPath(String componentName,
                     String parameterName)

Parameters:

componentName - should not be null

parameterName - should not be null

Method Detail

getComponentName

public String getComponentName()

Gets the component this parameter belongs to.

Returns:

The component name.

getParameterName

public String getParameterName()

Gets the parameter name.

Returns:

the parameter name

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

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

valueOf

public static ParameterPath valueOf(String pathString)

reverse operation from toString(): creates a ParameterPath from a String. It supports both old and new configuration parameter formatting.

Parameters:

pathString - should be of the form componentName/parameterName" where componentPath could also be a path (example: "carousel/tickMillis", "main/tick/taskPeriodMillis")

Returns:

a ParameterPath out of the given path String

Throws:

IllegalArgumentException - if pathString is not a path.