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

An object that describes an Agent's full configuration. It contains: - the Set of all the categories - for each category it contains the corresponding CategoryTag object that describes all the tags applied for a given category. - the GlobalName and its version

Author:

emarin

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ConfigurationDescription() Default empty constructor.
ConfigurationDescription(Set<String> categories) Build a ConfigurationDescription from the Set of categories.

Method Summary

Modifier and Type	Method and Description
void	addCategoryTag(CategoryDescription categoryTag)
ConfigurationDescription	cloneForCategories(Set<String> categories)
boolean	containsCategory(String category)
String	convertToString(boolean showDefaultSources)
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.
CategoryDescription	getCategoryTag(String category)
String	getDescriptionName()
String	getFullDescriptionName()
int	getVersion()
int	hashCode()
static ConfigurationDescription	initialDefaultConfiguration(Set<String> categories) Create a ConfigurationDescription object with all the provided categories in the "safe" tag.
boolean	isEmpty()
ConfigurationDescription	merge(ConfigurationDescription input)
ConfigurationDescription	parseConfigurationDescription(String description)
ConfigurationDescription	parseConfigurationString(String... taggedCategories) Apply the provided category tags to the current ConfigurationDescription object.
void	putSingleTagForCategory(String cat, SingleCategoryTag sourcedTag, String version)
void	putSourcedTagForCategory(String cat, String tag, String source, String version)
void	putTagForCategory(String cat, String tag, String version) Deprecated.
void	removeCategory(String cat)
String	toString()
ConfigurationDescription	withDefaultInitial(boolean withDefaults)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_NAME

@Deprecated
public static final String DEFAULT_CONFIG_NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_INITIAL_CONFIG_NAME

@Deprecated
public static final String DEFAULT_INITIAL_CONFIG_NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_CAT

@Deprecated
public static final String DEFAULT_CAT

Deprecated.

See Also:

Constant Field Values

SAFE_CONFIG_NAME

@Deprecated
public static final String SAFE_CONFIG_NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ConfigurationDescription

public ConfigurationDescription()

Default empty constructor.

ConfigurationDescription

public ConfigurationDescription(Set<String> categories)

Build a ConfigurationDescription from the Set of categories.

Parameters:

categories - The Set of the configuration categories.

Method Detail

initialDefaultConfiguration

public static ConfigurationDescription initialDefaultConfiguration(Set<String> categories)

Create a ConfigurationDescription object with all the provided categories in the "safe" tag.

Parameters:

categories - The categories that are to be in the defaultInitial tag.

Returns:

The newly created ConfigurationDescription.

parseConfigurationString

public final ConfigurationDescription parseConfigurationString(String... taggedCategories)

Apply the provided category tags to the current ConfigurationDescription object.

Parameters:

taggedCategories - The category tags to be applied.

Returns:

The modified ConfigurationDescription.

parseConfigurationDescription

public final ConfigurationDescription parseConfigurationDescription(String description)

removeCategory

public void removeCategory(String cat)

withDefaultInitial

public ConfigurationDescription withDefaultInitial(boolean withDefaults)

addCategoryTag

public void addCategoryTag(CategoryDescription categoryTag)

putTagForCategory

@Deprecated
public void putTagForCategory(String cat,
                                          String tag,
                                          String version)

Deprecated.

putSourcedTagForCategory

public void putSourcedTagForCategory(String cat,
                                     String tag,
                                     String source,
                                     String version)

putSingleTagForCategory

public void putSingleTagForCategory(String cat,
                                    SingleCategoryTag sourcedTag,
                                    String version)

getCategoriesSet

public Set<String> getCategoriesSet()

Get the Set of categories in this description.

Returns:

The Set with the categories.

getCategoryTag

public CategoryDescription getCategoryTag(String category)

isEmpty

public boolean isEmpty()

containsCategory

public boolean containsCategory(String category)

getDescriptionName

public String getDescriptionName()

getFullDescriptionName

public String getFullDescriptionName()

getVersion

public int getVersion()

cloneForCategories

public ConfigurationDescription cloneForCategories(Set<String> categories)

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

convertToString

public String convertToString(boolean showDefaultSources)

fromConfigurationInfo

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

fromConfigurationInfo

public static ConfigurationDescription fromConfigurationInfo(ConfigurationInfo ci)