forestry.api.genetics

Enum IClassification.EnumClassLevel

java.lang.Object

java.lang.Enum<IClassification.EnumClassLevel>

forestry.api.genetics.IClassification.EnumClassLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IClassification.EnumClassLevel>

Enclosing interface:

IClassification

public static enum IClassification.EnumClassLevel
extends java.lang.Enum<IClassification.EnumClassLevel>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASS
DIVISION
DOMAIN
FAMILY
GENUS
KINGDOM
ORDER
PHYLUM
SUBFAMILY
TRIBE

Method Summary

Modifier and Type	Method and Description
int	getColour()
boolean	isDroppable()
static IClassification.EnumClassLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IClassification.EnumClassLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOMAIN

public static final IClassification.EnumClassLevel DOMAIN

KINGDOM

public static final IClassification.EnumClassLevel KINGDOM

PHYLUM

public static final IClassification.EnumClassLevel PHYLUM

DIVISION

public static final IClassification.EnumClassLevel DIVISION

CLASS

public static final IClassification.EnumClassLevel CLASS

ORDER

public static final IClassification.EnumClassLevel ORDER

FAMILY

public static final IClassification.EnumClassLevel FAMILY

SUBFAMILY

public static final IClassification.EnumClassLevel SUBFAMILY

TRIBE

public static final IClassification.EnumClassLevel TRIBE

GENUS

public static final IClassification.EnumClassLevel GENUS

Method Detail

values

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

Returns:

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

valueOf

public static IClassification.EnumClassLevel valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getColour

public int getColour()

Returns:

Colour to use for displaying this classification.

isDroppable

public boolean isDroppable()

Returns:

Indicates whether display of this classification level can be ommitted in case of space constraints.