de.SweetCode.SteamAPI.method.option

Class Option

java.lang.Object

de.SweetCode.SteamAPI.method.option.Option

Direct Known Subclasses:

AppIDOption, CountOption, FilterOption, KeyOption, LimitOption, SessionIDOption, SteamIDOption, TimeBeginOption, TimeEndOption

public class Option
extends Object

Metods require you to provide data along with your calls to them. This class represents these options.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Option(String key, List<String> dependencies, String description, OptionType optionType, boolean required, boolean partnerRequired) Constructor to create an option with dependencies.
Option(String key, String description, OptionType optionType, boolean required, boolean partnerRequired) Constructor to create an option without dependencies.

Method Summary

Modifier and Type	Method and Description
static Option.Builder	create() Creates a new instance of Option.Builder.
List<String>	getDependencies() A list of keys describing dependencies between options.
Optional<String>	getDescription() The description of the option.
String	getKey() The key of the option.
OptionType	getOptionType() The type of the option.
boolean	isPartnerRequired() If the option is required if it is in the SteamHost.PARTNER mode.
boolean	isRequired() If the option is required or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

public Option(String key,
              List<String> dependencies,
              String description,
              OptionType optionType,
              boolean required,
              boolean partnerRequired)

Constructor to create an option with dependencies.

Parameters:

key - The unique key of the option.

dependencies - The keys of the options this option is depending on.

description - The description of the option, can be null.

optionType - The type of the option.

required - If the option is required or not.

partnerRequired - If the option is required if the SteamHost.PARTNER is used.

Option

public Option(String key,
              String description,
              OptionType optionType,
              boolean required,
              boolean partnerRequired)

Constructor to create an option without dependencies.

Parameters:

key - The unique key of the option.

description - The description of the option, can be null.

optionType - The type of the option.

required - If the option is required or not.

partnerRequired - If the option is required if the SteamHost.PARTNER is used.

Method Detail

getKey

public String getKey()

The key of the option.

Returns:

the key of the option, never null.

getDependencies

public List<String> getDependencies()

A list of keys describing dependencies between options.

Returns:

getDescription

public Optional<String> getDescription()

The description of the option.

Returns:

the description, if one is available, otherwise Optional.empty().

getOptionType

public OptionType getOptionType()

The type of the option.

Returns:

the option type, never null.

isRequired

public boolean isRequired()

If the option is required or not.

Returns:

true, if the option is required, otherwise false.

isPartnerRequired

public boolean isPartnerRequired()

If the option is required if it is in the SteamHost.PARTNER mode.

Returns:

true, if required in PARTNER mode, ohterwise false.

create

public static Option.Builder create()

Creates a new instance of Option.Builder.

Returns:

the builder instance.