Package net.sf.freecol.common.model

Enum HistoryEvent.HistoryEventType

java.lang.Object

java.lang.Enum<HistoryEvent.HistoryEventType>

net.sf.freecol.common.model.HistoryEvent.HistoryEventType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HistoryEvent.HistoryEventType>, Named

Enclosing class:

HistoryEvent

public static enum HistoryEvent.HistoryEventType
extends java.lang.Enum<HistoryEvent.HistoryEventType>
implements Named

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABANDON_COLONY
CEASE_FIRE
CITY_OF_GOLD
COLONY_CONQUERED
COLONY_DESTROYED
CONQUER_COLONY
DECLARE_INDEPENDENCE
DECLARE_WAR
DESTROY_NATION
DESTROY_SETTLEMENT
DISCOVER_NEW_WORLD
DISCOVER_REGION
FORM_ALLIANCE
FOUND_COLONY
FOUNDING_FATHER
INDEPENDENCE
MAKE_PEACE
MEET_NATION
NATION_DESTROYED
SPANISH_SUCCESSION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HistoryEventType()

Method Summary

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

DISCOVER_NEW_WORLD

public static final HistoryEvent.HistoryEventType DISCOVER_NEW_WORLD

DISCOVER_REGION

public static final HistoryEvent.HistoryEventType DISCOVER_REGION

MEET_NATION

public static final HistoryEvent.HistoryEventType MEET_NATION

CITY_OF_GOLD

public static final HistoryEvent.HistoryEventType CITY_OF_GOLD

FOUND_COLONY

public static final HistoryEvent.HistoryEventType FOUND_COLONY

ABANDON_COLONY

public static final HistoryEvent.HistoryEventType ABANDON_COLONY

CONQUER_COLONY

public static final HistoryEvent.HistoryEventType CONQUER_COLONY

COLONY_DESTROYED

public static final HistoryEvent.HistoryEventType COLONY_DESTROYED

COLONY_CONQUERED

public static final HistoryEvent.HistoryEventType COLONY_CONQUERED

DESTROY_SETTLEMENT

public static final HistoryEvent.HistoryEventType DESTROY_SETTLEMENT

DESTROY_NATION

public static final HistoryEvent.HistoryEventType DESTROY_NATION

FOUNDING_FATHER

public static final HistoryEvent.HistoryEventType FOUNDING_FATHER

DECLARE_INDEPENDENCE

public static final HistoryEvent.HistoryEventType DECLARE_INDEPENDENCE

INDEPENDENCE

public static final HistoryEvent.HistoryEventType INDEPENDENCE

SPANISH_SUCCESSION

public static final HistoryEvent.HistoryEventType SPANISH_SUCCESSION

DECLARE_WAR

public static final HistoryEvent.HistoryEventType DECLARE_WAR

CEASE_FIRE

public static final HistoryEvent.HistoryEventType CEASE_FIRE

MAKE_PEACE

public static final HistoryEvent.HistoryEventType MAKE_PEACE

FORM_ALLIANCE

public static final HistoryEvent.HistoryEventType FORM_ALLIANCE

NATION_DESTROYED

public static final HistoryEvent.HistoryEventType NATION_DESTROYED

Constructor Detail

HistoryEventType

private HistoryEventType()

Method Detail

values

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

Returns:

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

valueOf

public static HistoryEvent.HistoryEventType 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 the stem key.

Returns:

The stem key for this history event type.

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.