de.SweetCode.SteamAPI.interfaces

Class SteamInterface

java.lang.Object

de.SweetCode.SteamAPI.interfaces.SteamInterface

Direct Known Subclasses:

IAccountRecoveryService, IBroadcastService, ICheatReportingService, IEconMarketService, IEconService, IGameInventory, IGameNotificationsService, IGameServersService, IInventoryService, IPlayerService, ISteamApps, ISteamCDN, ISteamCommunity, ISteamDirectory, ISteamGameServerStats, ISteamLeaderboards, ISteamNews, ISteamRemoteStorage, ISteamSpecialSurvey, ISteamUser, ISteamUserAuth, ISteamUserOAuth, ISteamVideo, ISteamWebAPIUtil, ISteamWebUserPresenceOAuth, ISteamWorkshop

public abstract class SteamInterface
extends Object

The steam API is divided into interfaces, methods and versions. - This class represents the abstract idea of the Steam Interface.

Constructor Summary

Constructors

Constructor and Description
SteamInterface(SteamAPI steam, String name) A constructor to create a SteamInterface.

Method Summary

Modifier and Type	Method and Description
void	add(SteamMethod method) Adds a method to the interface.
<T extends SteamMethod> T	get(Class<T> method) Gives a method according to the provided class IF the method belongs to this interface.
Map<Class<? extends SteamMethod>,SteamMethod>	getMethods() Gives a list of all related methods.
String	getName() Gives the name of the interface which can be directly used in URLs to access the API.
SteamAPI	getSteam() Gives the Steam API instance this interface belongs to.

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamInterface

public SteamInterface(SteamAPI steam,
                      String name)

A constructor to create a SteamInterface.

Parameters:

steam - The instance of the Steam API the interface belongs to.

name - The name of the interface which can be directly used in URLs to access the API.

Method Detail

getName

public String getName()

Gives the name of the interface which can be directly used in URLs to access the API.

Returns:

Always string, never null.

getSteam

public SteamAPI getSteam()

Gives the Steam API instance this interface belongs to.

Returns:

The Steam API instance, never null.

getMethods

public Map<Class<? extends SteamMethod>,SteamMethod> getMethods()

Gives a list of all related methods.

Returns:

A list of all supported methods. Is never null. Can be empty.

get

public <T extends SteamMethod> T get(Class<T> method)

Gives a method according to the provided class IF the method belongs to this interface.

Type Parameters:

T - the Steam Method type

Parameters:

method - The method to search for.

Returns:

The SteamMethod instance.

add

public void add(SteamMethod method)

Adds a method to the interface.

Parameters:

method - The method to add.