starvationevasion.common

Enum EnumFood

java.lang.Object

java.lang.Enum<EnumFood>

starvationevasion.common.EnumFood

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumFood>, JSON, Sendable

public enum EnumFood
extends java.lang.Enum<EnumFood>
implements Sendable

The game models the following 12 farm product categories.

All farm products throughout the world used for food, animal feed and/or biofuel are modeled as belonging to one of the above 12 categories.

Farm products not modeled include Lumber, Cotton, and Wool.

Nested Class Summary

Nested classes/interfaces inherited from interface starvationevasion.server.io.JSON

JSON.Parser

Enum Constant Summary

Enum Constants

Enum Constant and Description
CITRUS
DAIRY
FEED
FISH
FRUIT
GRAIN
MEAT
NUT
OIL
POULTRY
SPECIAL
VEGGIES

Field Summary

Fields

Modifier and Type	Field and Description
static EnumFood[]	CROP_FOODS Array of all crop foods used in the game.
static EnumFood[]	NON_CROP_FOODS Array of all non-crop foods used in game.
static int	SIZE

Method Summary

Modifier and Type	Method and Description
void	fromJSON(java.lang.Object doc) Convert String into JSON
java.lang.String	getIconPath265()
java.lang.String	getIconPath64()
java.lang.String	getType()
abstract boolean	isCrop() Use when need to distinguish between crop and non-crop foods.
void	setType(java.lang.String type)
JSONDocument	toJSON() Convert class into json
java.lang.String	toLongString()
java.lang.String	toString()
static EnumFood	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumFood[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CITRUS

public static final EnumFood CITRUS

FRUIT

public static final EnumFood FRUIT

NUT

public static final EnumFood NUT

GRAIN

public static final EnumFood GRAIN

OIL

public static final EnumFood OIL

VEGGIES

public static final EnumFood VEGGIES

SPECIAL

public static final EnumFood SPECIAL

FEED

public static final EnumFood FEED

FISH

public static final EnumFood FISH

MEAT

public static final EnumFood MEAT

POULTRY

public static final EnumFood POULTRY

DAIRY

public static final EnumFood DAIRY

Field Detail

CROP_FOODS

public static final EnumFood[] CROP_FOODS

Array of all crop foods used in the game.

NON_CROP_FOODS

public static final EnumFood[] NON_CROP_FOODS

Array of all non-crop foods used in game.

SIZE

public static final int SIZE

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<EnumFood>

Returns:

test name of food type.

toLongString

public java.lang.String toLongString()

Returns:

text name of food type with example foods of type.

getIconPath64

public java.lang.String getIconPath64()

Returns:

file path of small icon.

getIconPath265

public java.lang.String getIconPath265()

Returns:

file path of large icon.

toJSON

public JSONDocument toJSON()

Description copied from interface: JSON

Convert class into json

Specified by:

toJSON in interface JSON

Returns:

JSON representation of class

fromJSON

public void fromJSON(java.lang.Object doc)

Description copied from interface: JSON

Convert String into JSON

Specified by:

fromJSON in interface JSON

Parameters:

doc - object to be converted

getType

public java.lang.String getType()

Specified by:

getType in interface Sendable

setType

public void setType(java.lang.String type)

Specified by:

setType in interface Sendable

isCrop

public abstract boolean isCrop()

Use when need to distinguish between crop and non-crop foods. For example, it does not make sense to apply fertilizer to meat, poultry or dairy.

Returns:

true if the food is a crop.