bwapi

Enum Latency

java.lang.Object

java.lang.Enum<Latency>

bwapi.Latency

All Implemented Interfaces:

Serializable, Comparable<Latency>

public enum Latency
extends Enum<Latency>

Contains enumeration of known latency values.

See Also:

Game.getLatency()

Enum Constant Summary

Enum Constants

Enum Constant and Description
BattlenetHigh
BattlenetLow
BattlenetMedium
LanHigh
LanLow
LanMedium
SinglePlayer

Field Summary

Fields

Modifier and Type	Field and Description
int	id

Method Summary

Modifier and Type	Method and Description
static Latency	valueOf(String name) Returns the enum constant of this type with the specified name.
static Latency[]	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

SinglePlayer

public static final Latency SinglePlayer

LanLow

public static final Latency LanLow

LanMedium

public static final Latency LanMedium

LanHigh

public static final Latency LanHigh

BattlenetLow

public static final Latency BattlenetLow

BattlenetMedium

public static final Latency BattlenetMedium

BattlenetHigh

public static final Latency BattlenetHigh

Field Detail

id

public final int id

Method Detail

values

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

Returns:

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

valueOf

public static Latency valueOf(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:

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

NullPointerException - if the argument is null