Package net.sf.freecol.common.model

Enum NationOptions.Advantages

java.lang.Object

java.lang.Enum<NationOptions.Advantages>

net.sf.freecol.common.model.NationOptions.Advantages

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NationOptions.Advantages>, Named

Enclosing class:

NationOptions

public static enum NationOptions.Advantages
extends java.lang.Enum<NationOptions.Advantages>
implements Named

Type of national advantages for European players.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIXED
NONE
SELECTABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Advantages()

Method Summary

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

FIXED

public static final NationOptions.Advantages FIXED

SELECTABLE

public static final NationOptions.Advantages SELECTABLE

Constructor Detail

Advantages

private Advantages()

Method Detail

values

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

Returns:

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

valueOf

public static NationOptions.Advantages 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 for this Advantages.

Returns:

A message key.

getShortDescriptionKey

public final java.lang.String getShortDescriptionKey()

getNameKey

public final 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.