Package net.sf.freecol.client.gui

Enum ImageLibrary.PathType

java.lang.Object

java.lang.Enum<ImageLibrary.PathType>

net.sf.freecol.client.gui.ImageLibrary.PathType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ImageLibrary.PathType>

Enclosing class:

ImageLibrary

public static enum ImageLibrary.PathType
extends java.lang.Enum<ImageLibrary.PathType>

Helper to distinguish different types of paths.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOOT
HORSE
NAVAL
WAGON

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PathType()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getImageKey()
private java.lang.String	getKey()	Get a key for this path type.
java.lang.String	getNextTurnImageKey()
static ImageLibrary.PathType	getPathType(Unit u)	Get the broad class of image to show along unit paths.
static ImageLibrary.PathType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ImageLibrary.PathType[]	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

NAVAL

public static final ImageLibrary.PathType NAVAL

WAGON

public static final ImageLibrary.PathType WAGON

HORSE

public static final ImageLibrary.PathType HORSE

FOOT

public static final ImageLibrary.PathType FOOT

Constructor Detail

PathType

private PathType()

Method Detail

values

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

Returns:

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

valueOf

public static ImageLibrary.PathType 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 key for this path type.

Returns:

A key.

getImageKey

public java.lang.String getImageKey()

getNextTurnImageKey

public java.lang.String getNextTurnImageKey()

getPathType

public static ImageLibrary.PathType getPathType(Unit u)

Get the broad class of image to show along unit paths.

Parameters:

u - A Unit to classify.

Returns:

A suitable PathType.