Package org.forgerock.opendj.config

Class Tag

java.lang.Object

org.forgerock.opendj.config.Tag

All Implemented Interfaces:

Comparable<Tag>

public final class Tag
extends Object
implements Comparable<Tag>

An interface for querying the properties of a tag.

Tags are used to group related managed objects together into categories.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Tag o)
static void	define(String name)	Defines a new tag with the specified name.
boolean	equals(Object obj)
String	getName()	Gets the name of this tag.
org.forgerock.i18n.LocalizableMessage	getSynopsis()	Gets the synopsis of this tag in the default locale.
org.forgerock.i18n.LocalizableMessage	getSynopsis(Locale locale)	Gets the synopsis of this tag in the specified locale.
int	hashCode()
String	toString()
static Tag	valueOf(String name)	Returns the tag associated with the specified name.
static Collection<Tag>	values()	Returns an unmodifiable collection view of the set of registered tags.

Methods inherited from class java.lang.Object

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

Method Detail

define

public static void define(String name)

Defines a new tag with the specified name.

Parameters:

name - The name of the new tag.

valueOf

public static Tag valueOf(String name)

Returns the tag associated with the specified name.

Parameters:

name - The name of the tag.

Returns:

Returns the tag associated with the specified name.

Throws:

IllegalArgumentException - If the tag name was not recognized.

values

public static Collection<Tag> values()

Returns an unmodifiable collection view of the set of registered tags.

Returns:

Returns an unmodifiable collection view of the set of registered tags.

compareTo

public final int compareTo(Tag o)

Specified by:

compareTo in interface Comparable<Tag>

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

getName

public final String getName()

Gets the name of this tag.

Returns:

Returns the name of this tag.

getSynopsis

public final org.forgerock.i18n.LocalizableMessage getSynopsis()

Gets the synopsis of this tag in the default locale.

Returns:

Returns the synopsis of this tag in the default locale.

getSynopsis

public final org.forgerock.i18n.LocalizableMessage getSynopsis(Locale locale)

Gets the synopsis of this tag in the specified locale.

Parameters:

locale - The locale.

Returns:

Returns the synopsis of this tag in the specified locale.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object