Package com.github.ocraft.s2client.protocol.unit

Enum Alliance

java.lang.Object

java.lang.Enum<Alliance>

com.github.ocraft.s2client.protocol.unit.Alliance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Alliance>

public enum Alliance
extends java.lang.Enum<Alliance>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLY
ENEMY
NEUTRAL
SELF

Method Summary

Modifier and Type	Method	Description
static Alliance	from(int sc2ApiPlayerRelative)
static Alliance	from(SC2APIProtocol.Raw.Alliance sc2ApiAlliance)
static Alliance	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Alliance[]	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

SELF

public static final Alliance SELF

ALLY

public static final Alliance ALLY

ENEMY

public static final Alliance ENEMY

NEUTRAL

public static final Alliance NEUTRAL

Method Detail

values

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

Returns:

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

valueOf

public static Alliance 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

from

public static Alliance from(SC2APIProtocol.Raw.Alliance sc2ApiAlliance)

from

public static Alliance from(int sc2ApiPlayerRelative)