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, useGENERIC
. TheGENERIC
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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Gets the short version of the name type.static NameType
valueOf(String name)
Returns the enum constant of this type with the specified name.static NameType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Method Detail
-
values
public static NameType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NameType c : NameType.values()) System.out.println(c);
- 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 nameNullPointerException
- if the argument is null
-
getName
public String getName()
Gets the short version of the name type.- Returns:
- the NameType short string
-
-