Package net.sf.freecol.common.model

Enum Player.NoClaimReason

java.lang.Object

java.lang.Enum<Player.NoClaimReason>

net.sf.freecol.common.model.Player.NoClaimReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Player.NoClaimReason>, Named

Enclosing class:

Player

public static enum Player.NoClaimReason
extends java.lang.Enum<Player.NoClaimReason>
implements Named

A variety of reasons why a tile can not be claimed, either to found a settlement or just to be used by one, including the double negative NONE == "no reason" case.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EUROPEANS
NATIVES
NONE
OCCUPIED
RUMOUR
SETTLEMENT
TERRAIN
WATER
WORKED

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoClaimReason()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescriptionKey()
private java.lang.String	getKey()	Get a message key describing this reason.
java.lang.String	getNameKey()	Gets the name of this named object.
static Player.NoClaimReason	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Player.NoClaimReason[]	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

NONE

public static final Player.NoClaimReason NONE

TERRAIN

public static final Player.NoClaimReason TERRAIN

RUMOUR

public static final Player.NoClaimReason RUMOUR

WATER

public static final Player.NoClaimReason WATER

OCCUPIED

public static final Player.NoClaimReason OCCUPIED

SETTLEMENT

public static final Player.NoClaimReason SETTLEMENT

WORKED

public static final Player.NoClaimReason WORKED

EUROPEANS

public static final Player.NoClaimReason EUROPEANS

NATIVES

public static final Player.NoClaimReason NATIVES

Constructor Detail

NoClaimReason

private NoClaimReason()

Method Detail

values

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

Returns:

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

valueOf

public static Player.NoClaimReason 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

getKey

private java.lang.String getKey()

Get a message key describing this reason.

Returns:

A message key.

getDescriptionKey

public java.lang.String getDescriptionKey()

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.