Package org.gbif.api.vocabulary

Enum NamePart

java.lang.Object

java.lang.Enum<NamePart>

org.gbif.api.vocabulary.NamePart

All Implemented Interfaces:

Serializable, Comparable<NamePart>

public enum NamePart
extends Enum<NamePart>

Enumeration to indicate a part of a canonical scientific name.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERIC
INFRAGENERIC
INFRASPECIFIC
SPECIFIC

Method Summary

Modifier and Type	Method	Description
static NamePart	fromString(String namePart)	Case insensitive lookup of a NamePart by its name that does not throw an exception but returns null for a not found NamePart.
static NamePart	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NamePart[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GENERIC

public static final NamePart GENERIC

INFRAGENERIC

public static final NamePart INFRAGENERIC

SPECIFIC

public static final NamePart SPECIFIC

INFRASPECIFIC

public static final NamePart INFRASPECIFIC

Method Detail

values

public static NamePart[] 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 (NamePart c : NamePart.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NamePart 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

fromString

public static NamePart fromString(String namePart)

Case insensitive lookup of a NamePart by its name that does not throw an exception but returns null for a not found NamePart.

Parameters:

namePart - case insensitive name of name part

Returns:

the matching NamePart or null