forestry.core.genetics.alleles

Enum EnumAllele.Height

java.lang.Object

java.lang.Enum<EnumAllele.Height>

forestry.core.genetics.alleles.EnumAllele.Height

All Implemented Interfaces:

IAlleleValue<java.lang.Float>, java.io.Serializable, java.lang.Comparable<EnumAllele.Height>

Enclosing class:

EnumAllele

public static enum EnumAllele.Height
extends java.lang.Enum<EnumAllele.Height>
implements IAlleleValue<java.lang.Float>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE
GIGANTIC
LARGE
LARGER
LARGEST
SMALL
SMALLER
SMALLEST

Method Summary

Modifier and Type	Method and Description
java.lang.Float	getValue()
boolean	isDominant()
static EnumAllele.Height	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumAllele.Height[]	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

SMALLEST

public static final EnumAllele.Height SMALLEST

SMALLER

public static final EnumAllele.Height SMALLER

SMALL

public static final EnumAllele.Height SMALL

AVERAGE

public static final EnumAllele.Height AVERAGE

LARGE

public static final EnumAllele.Height LARGE

LARGER

public static final EnumAllele.Height LARGER

LARGEST

public static final EnumAllele.Height LARGEST

GIGANTIC

public static final EnumAllele.Height GIGANTIC

Method Detail

values

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

Returns:

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

valueOf

public static EnumAllele.Height 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

getValue

public java.lang.Float getValue()

Specified by:

getValue in interface IAlleleValue<java.lang.Float>

isDominant

public boolean isDominant()

Specified by:

isDominant in interface IAlleleValue<java.lang.Float>