de.SweetCode.SteamAPI.method.option

Enum OptionTypes

java.lang.Object

java.lang.Enum<OptionTypes>

de.SweetCode.SteamAPI.method.option.OptionTypes

All Implemented Interfaces:

OptionType, Serializable, Comparable<OptionTypes>

public enum OptionTypes
extends Enum<OptionTypes>
implements OptionType

Steam Web API SteaMethods need to provide options (or parameters) when called, and these options have types. This enum represents a list of all allowed option types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOL Represents a BOOL (boolean) in the Steam Web API and is also internally represented by a Boolean.
FLOAT Represents a FLOAT in the Steam Web API and is also internally represented by a Float.
INT_32 Represents an INT_32 (signed 32bit integer) in the Steam Web API and is internally represented by an Integer.
INT_64 Represents an INT_64 (signed 64bit integer) in the Steam Web API, but is internally represented by a Long since Java doesn't have directly 64bit integers, they are called long internally.
RAW_BINARY Represents RAW BINARY in the Steam Web API and is internally represented by a Byte[].
STRING Represents a STRING (String) in the Steam Web API and is internally represented by a String.
UINT_32 Represents an UINT_32 (unsigned 32bit integer) in the Steam Web API, but is internally represented by a Long since Java does not support unsigned-integers.
UINT_64 Represents an UINT_64 (unsigned 64bit integer) in the Steam Web API, but is internally represented by a Long since Java does not support unsigned-integers.

Method Summary

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

Methods inherited from interface de.SweetCode.SteamAPI.method.option.OptionType

check, getName, parse

Enum Constant Detail

STRING

public static final OptionTypes STRING

Represents a STRING (String) in the Steam Web API and is internally represented by a String.

UINT_32

public static final OptionTypes UINT_32

Represents an UINT_32 (unsigned 32bit integer) in the Steam Web API, but is internally represented by a Long since Java does not support unsigned-integers. To still keep the "unsigned" property of unsigned ints, the method OptionType.parse(Object) calls Math.abs(long) to only provide positive values.

UINT_64

public static final OptionTypes UINT_64

Represents an UINT_64 (unsigned 64bit integer) in the Steam Web API, but is internally represented by a Long since Java does not support unsigned-integers. To still keep the "unsigned" property of unsigned ints, the method OptionType.parse(Object) calls Math.abs(long) to only provide positive values.

INT_32

public static final OptionTypes INT_32

Represents an INT_32 (signed 32bit integer) in the Steam Web API and is internally represented by an Integer.

INT_64

public static final OptionTypes INT_64

Represents an INT_64 (signed 64bit integer) in the Steam Web API, but is internally represented by a Long since Java doesn't have directly 64bit integers, they are called long internally.

FLOAT

public static final OptionTypes FLOAT

Represents a FLOAT in the Steam Web API and is also internally represented by a Float.

BOOL

public static final OptionTypes BOOL

Represents a BOOL (boolean) in the Steam Web API and is also internally represented by a Boolean.

RAW_BINARY

public static final OptionTypes RAW_BINARY

Represents RAW BINARY in the Steam Web API and is internally represented by a Byte[].

Method Detail

values

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

Returns:

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

valueOf

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