Package org.lsst.ccs.config

Class ConfigurationParameterDescription

java.lang.Object

org.lsst.ccs.config.ConfigurationParameterDescription

public class ConfigurationParameterDescription
extends Object

A configuration parameter description class. This class is used to overwrite arguments as specified in the ConfigurationParameter annotation. The following is an example of how to create a custom ConfigurationParameterDescription: ConfigurationParameterDescription cpd = new ConfigurationParameterDescription().withName("somePar").withCategory("myCategory");

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor	Description
ConfigurationParameterDescription()

Method Summary

Modifier and Type	Method	Description
String	getCategory()
String	getDescription()
String	getName()
String	getUnits()
boolean	isEnabled()
ConfigurationParameterDescription	withCategory(String category)
ConfigurationParameterDescription	withDescription(String description)
ConfigurationParameterDescription	withIsEnabled(boolean isEnabled)
ConfigurationParameterDescription	withName(String name)
ConfigurationParameterDescription	withUnits(String units)

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationParameterDescription

public ConfigurationParameterDescription()

Method Details

withName

public ConfigurationParameterDescription withName(String name)

withDescription

public ConfigurationParameterDescription withDescription(String description)

withCategory

public ConfigurationParameterDescription withCategory(String category)

withUnits

public ConfigurationParameterDescription withUnits(String units)

withIsEnabled

public ConfigurationParameterDescription withIsEnabled(boolean isEnabled)

getName

public String getName()

getDescription

public String getDescription()

getCategory

public String getCategory()

getUnits

public String getUnits()

isEnabled

public boolean isEnabled()