Package com.github.ocraft.s2client.protocol.game

Enum Race

java.lang.Object

java.lang.Enum<Race>

com.github.ocraft.s2client.protocol.game.Race

All Implemented Interfaces:

Sc2ApiSerializable<SC2APIProtocol.Common.Race>, java.io.Serializable, java.lang.Comparable<Race>

public enum Race
extends java.lang.Enum<Race>
implements Sc2ApiSerializable<SC2APIProtocol.Common.Race>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_RACE
PROTOSS
RANDOM
TERRAN
ZERG

Method Summary

Modifier and Type	Method	Description
static Race	forName(java.lang.String raceName)
static Race	from(SC2APIProtocol.Common.Race sc2ApiRace)
SC2APIProtocol.Common.Race	toSc2Api()
static Race	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Race[]	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

NO_RACE

public static final Race NO_RACE

TERRAN

public static final Race TERRAN

ZERG

public static final Race ZERG

PROTOSS

public static final Race PROTOSS

RANDOM

public static final Race RANDOM

Method Detail

values

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

Returns:

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

valueOf

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

toSc2Api

public SC2APIProtocol.Common.Race toSc2Api()

Specified by:

toSc2Api in interface Sc2ApiSerializable<SC2APIProtocol.Common.Race>

from

public static Race from(SC2APIProtocol.Common.Race sc2ApiRace)

forName

public static Race forName(java.lang.String raceName)