net.sf.freecol.common.model

Enum Player.Stance

java.lang.Object

java.lang.Enum<Player.Stance>

net.sf.freecol.common.model.Player.Stance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Player.Stance>

Enclosing class:

Player

public static enum Player.Stance
extends java.lang.Enum<Player.Stance>

The stance one player has towards another player.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLIANCE
CEASE_FIRE
PEACE
UNCONTACTED
WAR

Method Summary

Modifier and Type	Method and Description
private void	badStance()
private void	badTransition(Player.Stance newStance)
java.lang.String	getKey() Gets a key for this stance.
StringTemplate	getLabel() Get a label for this stance.
Player.Stance	getStanceFromTension(Tension tension) Check whether tension has changed enough to merit a stance change.
int	getTensionModifier(Player.Stance newStance) A stance change is about to happen.
static Player.Stance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Player.Stance[]	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

UNCONTACTED

public static final Player.Stance UNCONTACTED

ALLIANCE

public static final Player.Stance ALLIANCE

PEACE

public static final Player.Stance PEACE

CEASE_FIRE

public static final Player.Stance CEASE_FIRE

WAR

public static final Player.Stance WAR

Method Detail

values

public static Player.Stance[] 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.Stance c : Player.Stance.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.Stance 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

badStance

private void badStance()

badTransition

private void badTransition(Player.Stance newStance)

getStanceFromTension

public Player.Stance getStanceFromTension(Tension tension)

Check whether tension has changed enough to merit a stance change. Do not simply check for crossing tension thresholds, add in Tension.DELTA to provide a bit of hysteresis to dampen ringing.

Parameters:

tension - The Tension to check.

Returns:

The Stance appropriate to the tension level.

getTensionModifier

public int getTensionModifier(Player.Stance newStance)
                       throws java.lang.IllegalStateException

A stance change is about to happen. Get the appropriate tension modifier.

Parameters:

newStance - The new Stance.

Returns:

A modifier to the current tension.

Throws:

java.lang.IllegalStateException

getKey

public java.lang.String getKey()

Gets a key for this stance.

Returns:

The stance key.

getLabel

public StringTemplate getLabel()

Get a label for this stance.

Returns:

A StringTemplate for this stance.