Package net.sf.freecol.common.model

Enum Unit.MoveType

java.lang.Object

java.lang.Enum<Unit.MoveType>

net.sf.freecol.common.model.Unit.MoveType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Unit.MoveType>

Enclosing class:

Unit

public static enum Unit.MoveType
extends java.lang.Enum<Unit.MoveType>

A move type.

See Also:

Unit.getMoveType(Direction)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACK_SETTLEMENT
ATTACK_UNIT
EMBARK
ENTER_FOREIGN_COLONY_WITH_SCOUT
ENTER_INDIAN_SETTLEMENT_WITH_FREE_COLONIST
ENTER_INDIAN_SETTLEMENT_WITH_MISSIONARY
ENTER_INDIAN_SETTLEMENT_WITH_SCOUT
ENTER_SETTLEMENT_WITH_CARRIER_AND_GOODS
EXPLORE_LOST_CITY_RUMOUR
MOVE
MOVE_HIGH_SEAS
MOVE_ILLEGAL
MOVE_NO_ACCESS_BEACHED
MOVE_NO_ACCESS_CONTACT
MOVE_NO_ACCESS_EMBARK
MOVE_NO_ACCESS_FULL
MOVE_NO_ACCESS_GOODS
MOVE_NO_ACCESS_LAND
MOVE_NO_ACCESS_MISSION_BAN
MOVE_NO_ACCESS_SETTLEMENT
MOVE_NO_ACCESS_SKILL
MOVE_NO_ACCESS_TRADE
MOVE_NO_ACCESS_WAR
MOVE_NO_ACCESS_WATER
MOVE_NO_ATTACK_CIVILIAN
MOVE_NO_ATTACK_MARINE
MOVE_NO_EUROPE
MOVE_NO_MOVES
MOVE_NO_REPAIR
MOVE_NO_TILE

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	progress	Does this move type imply progress towards a destination.
private java.lang.String	reason	The reason why this move type is illegal.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MoveType(java.lang.String reason)
private	MoveType(java.lang.String reason, boolean progress)

Method Summary

Modifier and Type	Method	Description
boolean	isAttack()
boolean	isLegal()
boolean	isProgress()
static Unit.MoveType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Unit.MoveType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
java.lang.String	whyIllegal()

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

MOVE

public static final Unit.MoveType MOVE

MOVE_HIGH_SEAS

public static final Unit.MoveType MOVE_HIGH_SEAS

EXPLORE_LOST_CITY_RUMOUR

public static final Unit.MoveType EXPLORE_LOST_CITY_RUMOUR

ATTACK_UNIT

public static final Unit.MoveType ATTACK_UNIT

ATTACK_SETTLEMENT

public static final Unit.MoveType ATTACK_SETTLEMENT

EMBARK

public static final Unit.MoveType EMBARK

ENTER_INDIAN_SETTLEMENT_WITH_FREE_COLONIST

public static final Unit.MoveType ENTER_INDIAN_SETTLEMENT_WITH_FREE_COLONIST

ENTER_INDIAN_SETTLEMENT_WITH_SCOUT

public static final Unit.MoveType ENTER_INDIAN_SETTLEMENT_WITH_SCOUT

ENTER_INDIAN_SETTLEMENT_WITH_MISSIONARY

public static final Unit.MoveType ENTER_INDIAN_SETTLEMENT_WITH_MISSIONARY

ENTER_FOREIGN_COLONY_WITH_SCOUT

public static final Unit.MoveType ENTER_FOREIGN_COLONY_WITH_SCOUT

ENTER_SETTLEMENT_WITH_CARRIER_AND_GOODS

public static final Unit.MoveType ENTER_SETTLEMENT_WITH_CARRIER_AND_GOODS

MOVE_NO_MOVES

public static final Unit.MoveType MOVE_NO_MOVES

MOVE_NO_ACCESS_LAND

public static final Unit.MoveType MOVE_NO_ACCESS_LAND

MOVE_NO_ACCESS_BEACHED

public static final Unit.MoveType MOVE_NO_ACCESS_BEACHED

MOVE_NO_ACCESS_EMBARK

public static final Unit.MoveType MOVE_NO_ACCESS_EMBARK

MOVE_NO_ACCESS_FULL

public static final Unit.MoveType MOVE_NO_ACCESS_FULL

MOVE_NO_ACCESS_GOODS

public static final Unit.MoveType MOVE_NO_ACCESS_GOODS

MOVE_NO_ACCESS_CONTACT

public static final Unit.MoveType MOVE_NO_ACCESS_CONTACT

MOVE_NO_ACCESS_MISSION_BAN

public static final Unit.MoveType MOVE_NO_ACCESS_MISSION_BAN

MOVE_NO_ACCESS_SETTLEMENT

public static final Unit.MoveType MOVE_NO_ACCESS_SETTLEMENT

MOVE_NO_ACCESS_SKILL

public static final Unit.MoveType MOVE_NO_ACCESS_SKILL

MOVE_NO_ACCESS_TRADE

public static final Unit.MoveType MOVE_NO_ACCESS_TRADE

MOVE_NO_ACCESS_WAR

public static final Unit.MoveType MOVE_NO_ACCESS_WAR

MOVE_NO_ACCESS_WATER

public static final Unit.MoveType MOVE_NO_ACCESS_WATER

MOVE_NO_ATTACK_CIVILIAN

public static final Unit.MoveType MOVE_NO_ATTACK_CIVILIAN

MOVE_NO_ATTACK_MARINE

public static final Unit.MoveType MOVE_NO_ATTACK_MARINE

MOVE_NO_EUROPE

public static final Unit.MoveType MOVE_NO_EUROPE

MOVE_NO_REPAIR

public static final Unit.MoveType MOVE_NO_REPAIR

MOVE_NO_TILE

public static final Unit.MoveType MOVE_NO_TILE

MOVE_ILLEGAL

public static final Unit.MoveType MOVE_ILLEGAL

Field Detail

reason

private final java.lang.String reason

The reason why this move type is illegal.

progress

private final boolean progress

Does this move type imply progress towards a destination.

Constructor Detail

MoveType

private MoveType(java.lang.String reason)

MoveType

private MoveType(java.lang.String reason,
                 boolean progress)

Method Detail

values

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

Returns:

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

valueOf

public static Unit.MoveType 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

isLegal

public boolean isLegal()

whyIllegal

public java.lang.String whyIllegal()

isProgress

public boolean isProgress()

isAttack

public boolean isAttack()