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
All Methods Static Methods Instance Methods Concrete Methods 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.LocalizableMessage
getSynopsis()
Gets the synopsis of this tag in the default locale.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.
-
-
-
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 int compareTo(Tag o)
- Specified by:
compareTo
in interfaceComparable<Tag>
-
getName
public String getName()
Gets the name of this tag.- Returns:
- Returns the name of this tag.
-
getSynopsis
public 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 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.
-
-