starvationevasion.common

Enum EnumRegion

java.lang.Object

java.lang.Enum<EnumRegion>

starvationevasion.common.EnumRegion

All Implemented Interfaces:

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

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

Enumerates each of the geographic regions used in the game: both Player and non-Player regions.

The ordinal of US regions are continuous and less than all non-Player world regions.

Nested Class Summary

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

JSON.Parser

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCTIC_AMERICA
CENTRAL_ASIA
EAST_ASIA
EUROPE
MIDDLE_AMERICA
MIDDLE_EAST
OCEANIA
RUSSIA
SOUTH_AMERICA
SOUTH_ASIA
SOUTHEAST_ASIA
SUB_SAHARAN
USA_CALIFORNIA The US states in this region are: CA
USA_HEARTLAND The US states in this region are: IA, MO, IL, IN
USA_MOUNTAIN The US states in this region are: WA, OR, ID, NV, MT, WY, UT, CO, AZ, NM
USA_NORTHERN_CRESCENT The US states in this region are: ME, VT, HN, MA, RI, CT, NJ, NY, PA, DE, MD, OH, WI, MI
USA_NORTHERN_PLAINS The US states in this region are: ND, SD, NE, KS, MN
USA_SOUTHEAST The US states in this region are: FL, MS, AL, GA, TN, NC, SC, KY, WV, VA
USA_SOUTHERN_PLAINS The US states in this region are: TX, LA, OK, AR

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE
static EnumRegion[]	US_REGIONS Array of all player regions used in game.
static EnumRegion[]	WORLD_REGIONS Array of all non-player regions used in game.

Method Summary

Modifier and Type	Method and Description
static int	allUSRegionBits()
void	fromJSON(java.lang.Object doc) Convert String into JSON
int	getBit()
java.lang.String	getType()
boolean	isUS()
void	setType(java.lang.String type)
JSONDocument	toJSON() Convert class into json
java.lang.String	toString()
static EnumRegion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumRegion[]	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

USA_CALIFORNIA

public static final EnumRegion USA_CALIFORNIA

The US states in this region are: CA

USA_HEARTLAND

public static final EnumRegion USA_HEARTLAND

The US states in this region are: IA, MO, IL, IN

USA_NORTHERN_PLAINS

public static final EnumRegion USA_NORTHERN_PLAINS

The US states in this region are: ND, SD, NE, KS, MN

USA_SOUTHEAST

public static final EnumRegion USA_SOUTHEAST

The US states in this region are: FL, MS, AL, GA, TN, NC, SC, KY, WV, VA

USA_NORTHERN_CRESCENT

public static final EnumRegion USA_NORTHERN_CRESCENT

The US states in this region are: ME, VT, HN, MA, RI, CT, NJ, NY, PA, DE, MD, OH, WI, MI

USA_SOUTHERN_PLAINS

public static final EnumRegion USA_SOUTHERN_PLAINS

The US states in this region are: TX, LA, OK, AR

USA_MOUNTAIN

public static final EnumRegion USA_MOUNTAIN

The US states in this region are: WA, OR, ID, NV, MT, WY, UT, CO, AZ, NM

ARCTIC_AMERICA

public static final EnumRegion ARCTIC_AMERICA

MIDDLE_AMERICA

public static final EnumRegion MIDDLE_AMERICA

SOUTH_AMERICA

public static final EnumRegion SOUTH_AMERICA

EUROPE

public static final EnumRegion EUROPE

MIDDLE_EAST

public static final EnumRegion MIDDLE_EAST

SUB_SAHARAN

public static final EnumRegion SUB_SAHARAN

RUSSIA

public static final EnumRegion RUSSIA

CENTRAL_ASIA

public static final EnumRegion CENTRAL_ASIA

SOUTH_ASIA

public static final EnumRegion SOUTH_ASIA

EAST_ASIA

public static final EnumRegion EAST_ASIA

SOUTHEAST_ASIA

public static final EnumRegion SOUTHEAST_ASIA

OCEANIA

public static final EnumRegion OCEANIA

Field Detail

SIZE

public static final int SIZE

US_REGIONS

public static final EnumRegion[] US_REGIONS

Array of all player regions used in game.

WORLD_REGIONS

public static final EnumRegion[] WORLD_REGIONS

Array of all non-player regions used in game.

Method Detail

values

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

Returns:

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

valueOf

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

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

getBit

public int getBit()

Returns:

Returns an int with one bit set corresponding to the region's ordinal.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<EnumRegion>

allUSRegionBits

public static int allUSRegionBits()

isUS

public boolean isUS()

Returns:

true if and only of the region is a player region of the United States of America.