Package net.sf.freecol.common.model

Enum Region.RegionType

java.lang.Object

java.lang.Enum<Region.RegionType>

net.sf.freecol.common.model.Region.RegionType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Region.RegionType>, Named

Enclosing class:

Region

public static enum Region.RegionType
extends java.lang.Enum<Region.RegionType>
implements Named

The type of region.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COAST
DESERT
LAKE
LAND
MOUNTAIN
OCEAN
RIVER

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	claimable	Are regions of this type claimable by default?

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RegionType(boolean claimable)	Create a region type.

Method Summary

Modifier and Type	Method	Description
boolean	getClaimable()	Is this region claimable by default?
java.lang.String	getKey()	Get a stem key for this region type.
java.lang.String	getNameKey()	Gets the name of this named object.
java.lang.String	getUnknownKey()	Gets a message key for an unknown region of this type.
static Region.RegionType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Region.RegionType[]	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

OCEAN

public static final Region.RegionType OCEAN

COAST

public static final Region.RegionType COAST

LAKE

public static final Region.RegionType LAKE

RIVER

public static final Region.RegionType RIVER

LAND

public static final Region.RegionType LAND

MOUNTAIN

public static final Region.RegionType MOUNTAIN

DESERT

public static final Region.RegionType DESERT

Field Detail

claimable

private final boolean claimable

Are regions of this type claimable by default?

Constructor Detail

RegionType

private RegionType(boolean claimable)

Create a region type.

Parameters:

claimable - The default claimability of this region type.

Method Detail

values

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

Returns:

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

valueOf

public static Region.RegionType 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

getClaimable

public boolean getClaimable()

Is this region claimable by default?

Returns:

True if this region type is normally claimable.

getKey

public java.lang.String getKey()

Get a stem key for this region type.

Returns:

A stem key.

getUnknownKey

public java.lang.String getUnknownKey()

Gets a message key for an unknown region of this type.

Returns:

A message key.

getNameKey

public java.lang.String getNameKey()

Gets the name of this named object. Try to avoid using this directly except in i18n-related routines or to implement itself in more complext objects.

Specified by:

getNameKey in interface Named

Returns:

The name of the Named.