org.lsst.ccs.config

Class CategoryDescription

java.lang.Object

org.lsst.ccs.config.CategoryDescription

All Implemented Interfaces:

Serializable

public class CategoryDescription
extends Object
implements Serializable

Class that describes a category tag, i.e. the particular configuration tag that has been loaded for a given category. The syntax for a category tag is: "categoryName:tag1|tag2|tag3" where the pipe symbol "|" is used to separate the various tags that have been loaded for this category. Please note the following special cases: - "categoryName" means that the default tag ("") has been loaded for the given category - ":" means that the default tag ("") was loaded for the default category ("") - ":tag1" means that "tag1" was loaded for the default category ("") - "categoryName:tag1|tag2" means that "tag1" and "tag2" (in this order) have been loaded for category "categoryName"

Author:

The LSST CCS Team

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
static String	DEFAULT_V_STRING
static int	DEFAULT_VERSION
static int	LATEST_VERSION
static int	UNDEF_VERSION

Constructor Summary

Constructors

Constructor and Description
CategoryDescription(String categoryName, String defaultSource)

Method Summary

Modifier and Type	Method and Description
void	addOrUpdadateSingleTag(SingleCategoryTag singleCategoryTag)
void	addOrUpdadateSingleTagVersion(String source, String tag, String version)
void	addSingleTagVersion(SingleCategoryTag singleTag, String version, boolean update)
boolean	containsSingleTag(SingleCategoryTag singleCategoryTag)
boolean	containsSingleTag(String tag, String source) Deprecated.
String	convertToString(boolean showDefaultSource)
boolean	equals(Object obj)
String	getCategoryName()
List<SingleCategoryTag>	getSingleCategoryTags()
SingleCategoryTag	getSingleTag(SingleCategoryTag singleCategoryTag)
String	getSingleTagVersion(SingleCategoryTag singleCategoryTag)
SingleCategoryTag	getTopMostTag()
boolean	hasChanges()
int	hashCode()
CategoryDescription	merge(CategoryDescription categoryTag)
static CategoryDescription	parseCategoryTagInput(String categoryTagInput)
static CategoryDescription	parseCategoryTagInput(String categoryTagInput, Function<String,String> defaultSourcesFunction)
void	setHasChanges(boolean hasChanges)
String	toString()

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

public static final String DEFAULT_INITIAL_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_CAT

@Deprecated
public static final String DEFAULT_CAT

Deprecated.

See Also:

Constant Field Values

DEFAULT_V_STRING

public static final String DEFAULT_V_STRING

See Also:

Constant Field Values

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

LATEST_VERSION

public static final int LATEST_VERSION

See Also:

Constant Field Values

UNDEF_VERSION

public static final int UNDEF_VERSION

See Also:

Constant Field Values

Constructor Detail

CategoryDescription

public CategoryDescription(String categoryName,
                           String defaultSource)

Method Detail

getCategoryName

public String getCategoryName()

containsSingleTag

@Deprecated
public boolean containsSingleTag(String tag,
                                             String source)

Deprecated.

containsSingleTag

public boolean containsSingleTag(SingleCategoryTag singleCategoryTag)

getSingleTag

public SingleCategoryTag getSingleTag(SingleCategoryTag singleCategoryTag)

getSingleTagVersion

public String getSingleTagVersion(SingleCategoryTag singleCategoryTag)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

convertToString

public String convertToString(boolean showDefaultSource)

setHasChanges

public void setHasChanges(boolean hasChanges)

hasChanges

public boolean hasChanges()

getSingleCategoryTags

public List<SingleCategoryTag> getSingleCategoryTags()

getTopMostTag

public SingleCategoryTag getTopMostTag()

addOrUpdadateSingleTagVersion

public void addOrUpdadateSingleTagVersion(String source,
                                          String tag,
                                          String version)

addOrUpdadateSingleTag

public void addOrUpdadateSingleTag(SingleCategoryTag singleCategoryTag)

addSingleTagVersion

public void addSingleTagVersion(SingleCategoryTag singleTag,
                                String version,
                                boolean update)

merge

public CategoryDescription merge(CategoryDescription categoryTag)

parseCategoryTagInput

public static final CategoryDescription parseCategoryTagInput(String categoryTagInput)

parseCategoryTagInput

public static final CategoryDescription parseCategoryTagInput(String categoryTagInput,
                                                              Function<String,String> defaultSourcesFunction)