Package com.github.rumsfield.konquest.api.model

Enum Class KonquestRelationshipType

java.lang.Object

java.lang.Enum<KonquestRelationshipType>

com.github.rumsfield.konquest.api.model.KonquestRelationshipType

All Implemented Interfaces:

Serializable, Comparable<KonquestRelationshipType>, Constable

public enum KonquestRelationshipType
extends Enum<KonquestRelationshipType>

The types of player relationships in Konquest.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLY	Player/territory are in allied kingdoms
BARBARIAN	Player/territory is barbarian
ENEMY	Player/territory are in kingdoms at war
FRIENDLY	Player/territory are in the same kingdom
NEUTRAL	Territory has no kingdom (ruin, sanctuary, etc)
PEACEFUL	Player/territory are in kingdoms at peace
TRADE	Player/territory are in trading kingdoms

Method Summary

Modifier and Type	Method	Description
static KonquestRelationshipType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KonquestRelationshipType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BARBARIAN

public static final KonquestRelationshipType BARBARIAN

Player/territory is barbarian

NEUTRAL

public static final KonquestRelationshipType NEUTRAL

Territory has no kingdom (ruin, sanctuary, etc)

FRIENDLY

public static final KonquestRelationshipType FRIENDLY

Player/territory are in the same kingdom

ENEMY

public static final KonquestRelationshipType ENEMY

Player/territory are in kingdoms at war

PEACEFUL

public static final KonquestRelationshipType PEACEFUL

Player/territory are in kingdoms at peace

TRADE

public static final KonquestRelationshipType TRADE

Player/territory are in trading kingdoms

ALLY

public static final KonquestRelationshipType ALLY

Player/territory are in allied kingdoms

Method Details

values

public static KonquestRelationshipType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static KonquestRelationshipType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null