forestry.api.arboriculture

Enum EnumFruitFamily

java.lang.Object

java.lang.Enum<EnumFruitFamily>

forestry.api.arboriculture.EnumFruitFamily

All Implemented Interfaces:

IFruitFamily, java.io.Serializable, java.lang.Comparable<EnumFruitFamily>

public enum EnumFruitFamily
extends java.lang.Enum<EnumFruitFamily>
implements IFruitFamily

Enum Constant Summary

Enum Constants

Enum Constant and Description
JUNGLE
NONE
NUX
POMES
PRUNES

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getScientific() A scientific-y name for this fruit family
java.lang.String	getUID()
static EnumFruitFamily	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumFruitFamily[]	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

PRUNES

public static final EnumFruitFamily PRUNES

POMES

public static final EnumFruitFamily POMES

JUNGLE

public static final EnumFruitFamily JUNGLE

NUX

public static final EnumFruitFamily NUX

NONE

public static final EnumFruitFamily NONE

Method Detail

values

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

Returns:

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

valueOf

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

getUID

public java.lang.String getUID()

Specified by:

getUID in interface IFruitFamily

Returns:

Unique String identifier.

getScientific

public java.lang.String getScientific()

Description copied from interface: IFruitFamily

A scientific-y name for this fruit family

Specified by:

getScientific in interface IFruitFamily

Returns:

flavour text (may be null)

getName

public java.lang.String getName()

Specified by:

getName in interface IFruitFamily

Returns:

Localized family name for user display.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IFruitFamily

Returns:

Localized description of this fruit family. (May be null.)