de.SweetCode.SteamAPI

Enum SteamHost

java.lang.Object

java.lang.Enum<SteamHost>

de.SweetCode.SteamAPI.SteamHost

All Implemented Interfaces:

Serializable, Comparable<SteamHost>

public enum SteamHost
extends Enum<SteamHost>

Steam offers to different hosts to access their API.

• PUBLIC (api.steampowered.com) can be accessed either through HTTP or HTTPS since this API strictly enforces HTTPS should this not make a difference to you, however
• PARTNER (partner.steam-api.com) is a host only for Steam partners. It has a higher availability, it is not cached and you always need your partner API key, even for requests that normally do not require you to provide a key.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARTNER The host to access the partner API (partner.steam-api.com).
PUBLIC The host to access the public API (api.steampowered.com).

Method Summary

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

PUBLIC

public static final SteamHost PUBLIC

The host to access the public API (api.steampowered.com).

PARTNER

public static final SteamHost PARTNER

The host to access the partner API (partner.steam-api.com).

Method Detail

values

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

Returns:

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

valueOf

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

getHost

public String getHost()

Gives the according host.

Returns:

Always a string without any protocol related information, never null.