de.SweetCode.SteamAPI.method

Class SteamMethodVersion

java.lang.Object

de.SweetCode.SteamAPI.method.SteamMethodVersion

public class SteamMethodVersion
extends Object

A SteamMethod can have various versions supporting different Options, Steam Versions and/or Steam Hosts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SteamMethodVersion.Builder A builder pattern class to buildRequest easier SteamMethodVersion.

Constructor Summary

Constructors

Constructor and Description
SteamMethodVersion(SteamHTTPMethod method, List<SteamHost> hosts, SteamVersion version, SteamVisibility visibility) Creates a new SteamMethodVersion instance.

Method Summary

Modifier and Type	Method and Description
void	add(Option option) Adds a option if the option does not exist yet.
static SteamMethodVersion.Builder	create() Creates a new instance of SteamMethodVersion.Builder.
Option	get(String key) Gives the option related to the key.
List<SteamHost>	getHosts() All supported hosts.
SteamHTTPMethod	getMethod() The supported HTTP request method.
SteamVersion	getVersion() The version these options belong to.
SteamVisibility	getVisibility() Gives the visibility of the method.
boolean	verify(SteamMethod steamMethod, SteamHost host, Input input) Verifies if the input fits these SteamMethodVersion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SteamMethodVersion

public SteamMethodVersion(SteamHTTPMethod method,
                          List<SteamHost> hosts,
                          SteamVersion version,
                          SteamVisibility visibility)

Creates a new SteamMethodVersion instance.

Parameters:

method - The supported HTTP request method.

hosts - All supported hosts.

version - The version the options belong to.

visibility - The visibility of the method.

Method Detail

getMethod

public SteamHTTPMethod getMethod()

The supported HTTP request method.

Returns:

the supported HTTP request method, never null.

getHosts

public List<SteamHost> getHosts()

All supported hosts.

Returns:

a list of supported hosts.

getVersion

public SteamVersion getVersion()

The version these options belong to.

Returns:

the version, never null.

getVisibility

public SteamVisibility getVisibility()

Gives the visibility of the method.

Returns:

The visibility of the method, never null.

get

public Option get(String key)

Gives the option related to the key.

Parameters:

key - The key of the option.

Returns:

the related option, never null.

add

public void add(Option option)

Adds a option if the option does not exist yet.

Parameters:

option - The option to add.

verify

public boolean verify(SteamMethod steamMethod,
                      SteamHost host,
                      Input input)

Verifies if the input fits these SteamMethodVersion.

Parameters:

steamMethod - The SteamMethod calling the verify function.

host - The host which is supposed to receive the provided input.

input - The provided input.

Returns:

True, if the input fits, otherwise it throws exception.

create

public static SteamMethodVersion.Builder create()

Creates a new instance of SteamMethodVersion.Builder.

Returns:

the builder instance.