Package org.conical.common.bbl.enums

Enum Class NameSuffix

java.lang.Object
java.lang.Enum<NameSuffix>
org.conical.common.bbl.enums.NameSuffix
All Implemented Interfaces:
Serializable, Comparable<NameSuffix>, Constable, Described, Named
public enum NameSuffix extends Enum<NameSuffix> implements Named, Described
Enum keeps track of the variety of name suffixes the BBL documents and their attributes
Author:
rdoherty

  • Enum Constant Details

  • Method Details

    • values

      public static NameSuffix[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static NameSuffix valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Convenience method to provide getter access to name().
      Specified by:
      getName in interface Named
      Returns:
      same as name()

    • getDescription

      public String getDescription()
      Returns a human-readable description of what this value is/means or perhaps how it is used
      Specified by:
      getDescription in interface Described
      Returns:
      enum value description

    • resolveByDescription

      public static NameSuffix resolveByDescription(String string)