de.SweetCode.SteamAPI

Enum SteamVersion

java.lang.Object

java.lang.Enum<SteamVersion>

de.SweetCode.SteamAPI.SteamVersion

All Implemented Interfaces:

Serializable, Comparable<SteamVersion>

public enum SteamVersion
extends Enum<SteamVersion>

The steam API is divided into interfaces, methods and versions. - This class represents the abstract idea of the Steam Interface. A part of the Steam Web API is that methods which can be called can have various versions. This enum provides all of them, which allows the developer to specify which version of the method they wanna access.

Enum Constant Summary

Enum Constants

Enum Constant and Description
V_1 Representing the 'v1' version.
V_2 Representing the 'v2' version.
V_3 Representing the 'v3' version.

Method Summary

Modifier and Type	Method and Description
String	getHumanReadable() Gives a human readable version of the version name.
String	getUrlVersion() Gives the value which can be used to create requests.
static SteamVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static SteamVersion[]	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

V_1

public static final SteamVersion V_1

Representing the 'v1' version.

V_2

public static final SteamVersion V_2

Representing the 'v2' version.

V_3

public static final SteamVersion V_3

Representing the 'v3' version.

Method Detail

values

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

Returns:

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

valueOf

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

getUrlVersion

public String getUrlVersion()

Gives the value which can be used to create requests.

Returns:

Always a string, never null.

getHumanReadable

public String getHumanReadable()

Gives a human readable version of the version name. - The syntax of the string is: Version {number}.

Returns:

Always a string, never null.