forestry.core.genetics.alleles

Enum EnumAllele.Yield

java.lang.Object

java.lang.Enum<EnumAllele.Yield>

forestry.core.genetics.alleles.EnumAllele.Yield

All Implemented Interfaces:

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

Enclosing class:

EnumAllele

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE
HIGH
HIGHER
HIGHEST
LOW
LOWER
LOWEST

Method Summary

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

LOWEST

public static final EnumAllele.Yield LOWEST

LOWER

public static final EnumAllele.Yield LOWER

LOW

public static final EnumAllele.Yield LOW

AVERAGE

public static final EnumAllele.Yield AVERAGE

HIGH

public static final EnumAllele.Yield HIGH

HIGHER

public static final EnumAllele.Yield HIGHER

HIGHEST

public static final EnumAllele.Yield HIGHEST

Method Detail

values

public static EnumAllele.Yield[] 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.Yield c : EnumAllele.Yield.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.Yield 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>