Class 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 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.
      • 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.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object