Enum NameType

java.lang.Object
java.lang.Enum<NameType>
org.apache.commons.codec.language.bm.NameType
All Implemented Interfaces:
Serializable, Comparable<NameType>

public enum NameType extends Enum<NameType>
Supported types of names. Unless you are matching particular family names, use GENERIC. The GENERIC NameType should work reasonably well for non-name words. The other encodings are specifically tuned to family names, and may not work well at all for general text.
Since:
1.6
  • Enum Constant Details

  • Method Details

    • values

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

      public static NameType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null
    • getName

      public String getName()
      Gets the short version of the name type.
      Returns:
      the NameType short string