org.gbif.api.vocabulary

Enum Kingdom

java.lang.Object

java.lang.Enum<Kingdom>

org.gbif.api.vocabulary.Kingdom

All Implemented Interfaces:

Serializable, Comparable<Kingdom>

public enum Kingdom
extends Enum<Kingdom>

A simple enumeration of all kingdoms found in the GBIF Backbone Taxonomy and also Catalogue of Life.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANIMALIA
ARCHAEA
BACTERIA
CHROMISTA
FUNGI
INCERTAE_SEDIS
PLANTAE
PROTOZOA
VIRUSES

Method Summary

Modifier and Type	Method and Description
static Kingdom	byNubUsageId(int usageKey) Deprecated. please use byNubUsageId(int) instead
static Kingdom	byNubUsageKey(int usageKey) Looks up a kingdom by its nub usage key.
Integer	nubUsageID() Deprecated. please use nubUsageKey() instead
int	nubUsageKey()
String	scientificName()
static Kingdom	valueOf(String name) Returns the enum constant of this type with the specified name.
static Kingdom[]	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

INCERTAE_SEDIS

public static final Kingdom INCERTAE_SEDIS

ANIMALIA

public static final Kingdom ANIMALIA

ARCHAEA

public static final Kingdom ARCHAEA

BACTERIA

public static final Kingdom BACTERIA

CHROMISTA

public static final Kingdom CHROMISTA

FUNGI

public static final Kingdom FUNGI

PLANTAE

public static final Kingdom PLANTAE

PROTOZOA

public static final Kingdom PROTOZOA

VIRUSES

public static final Kingdom VIRUSES

Method Detail

values

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

Returns:

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

valueOf

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

byNubUsageKey

public static Kingdom byNubUsageKey(int usageKey)

Looks up a kingdom by its nub usage key.

Parameters:

usageKey - the nub usage key to lookup, must be < 9 to get a result.

Returns:

the matching kingdom or null

scientificName

public String scientificName()

Returns:

a unique single capital char representing the kingdom.

nubUsageKey

public int nubUsageKey()

nubUsageID

@Deprecated
public Integer nubUsageID()

Deprecated. please use nubUsageKey() instead

byNubUsageId

@Deprecated
public static Kingdom byNubUsageId(int usageKey)

Deprecated. please use byNubUsageId(int) instead