org.lsst.ccs.config

Class ConfigurationDescription

java.lang.Object

org.lsst.ccs.config.ConfigurationDescription

All Implemented Interfaces:

Serializable

public class ConfigurationDescription
extends Object
implements Serializable

A configuration summary.

Author:

emarin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CAT
static String	DEFAULT_CONFIG_NAME
static String	DEFAULT_INITIAL_CONFIG_NAME
static String	SAFE_CONFIG_NAME

Constructor Summary

Constructors

Constructor and Description
ConfigurationDescription()
ConfigurationDescription(Set<String> categories)

Method Summary

Modifier and Type	Method and Description
void	addCategoryTag(CategoryTag categoryTag)
boolean	containsCategory(String category)
boolean	equals(Object obj)
static ConfigurationDescription	fromConfigurationInfo(ConfigurationInfo ci)
static ConfigurationDescription	fromConfigurationInfo(ConfigurationInfo ci, Set<String> categories)
Set<String>	getCategoriesSet() Get the Set of categories in this description.
CategoryTag	getCategoryTag(String category)
Map<String,String>	getCategoryTags() Deprecated.
Map<String,Integer>	getCategoryVersions() Deprecated.
String	getDescriptionName()
String	getName()
int	getVersion()
int	hashCode()
boolean	isEmpty()
ConfigurationDescription	merge(ConfigurationDescription input)
ConfigurationDescription	parseConfigurationString(String... taggedCategories)
void	putTagForCategory(String cat, String tag, Integer version)
static ConfigurationDescription	safeConfiguration(Set<String> categories)
void	setName(String name, int version)
String	toString()
ConfigurationDescription	withDefaultInitial(boolean withDefaults)
ConfigurationDescription	withDefaults(boolean withDefaults)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_NAME

public static final String DEFAULT_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_INITIAL_CONFIG_NAME

public static final String DEFAULT_INITIAL_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_CAT

public static final String DEFAULT_CAT

See Also:

Constant Field Values

SAFE_CONFIG_NAME

public static final String SAFE_CONFIG_NAME

See Also:

Constant Field Values

Constructor Detail

ConfigurationDescription

public ConfigurationDescription()

ConfigurationDescription

public ConfigurationDescription(Set<String> categories)

Method Detail

safeConfiguration

public static ConfigurationDescription safeConfiguration(Set<String> categories)

parseConfigurationString

public ConfigurationDescription parseConfigurationString(String... taggedCategories)

withDefaults

public ConfigurationDescription withDefaults(boolean withDefaults)

withDefaultInitial

public ConfigurationDescription withDefaultInitial(boolean withDefaults)

addCategoryTag

public void addCategoryTag(CategoryTag categoryTag)

putTagForCategory

public void putTagForCategory(String cat,
                              String tag,
                              Integer version)

getCategoriesSet

public Set<String> getCategoriesSet()

Get the Set of categories in this description.

Returns:

The Set with the categories.

getCategoryTag

public CategoryTag getCategoryTag(String category)

getCategoryTags

@Deprecated
public Map<String,String> getCategoryTags()

Deprecated.

getCategoryVersions

@Deprecated
public Map<String,Integer> getCategoryVersions()

Deprecated.

isEmpty

public boolean isEmpty()

containsCategory

public boolean containsCategory(String category)

getDescriptionName

public String getDescriptionName()

getName

public String getName()

getVersion

public int getVersion()

setName

public void setName(String name,
                    int version)

merge

public ConfigurationDescription merge(ConfigurationDescription input)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

fromConfigurationInfo

public static ConfigurationDescription fromConfigurationInfo(ConfigurationInfo ci,
                                                             Set<String> categories)

fromConfigurationInfo

public static ConfigurationDescription fromConfigurationInfo(ConfigurationInfo ci)