de.SweetCode.SteamAPI.method.option

Class Option.Builder

java.lang.Object

de.SweetCode.SteamAPI.method.option.Option.Builder

Enclosing class:

Option

public static class Option.Builder
extends Object

A builder pattern class to buildRequest easier a Option.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Option.Builder	addDependecy(String key) Adds a key dependency to the option.
Option	build() Builds a new instance of Option with all provided values.
Option.Builder	description(String description) Sets the description of the option.
Option.Builder	isPartnerRequired(boolean isPartnerRequired) Sets if the option is required in SteamHost.PARTNER mode.
Option.Builder	isRequired(boolean isRequired) Sets if the option is required.
Option.Builder	key(String key) Sets the key of the option.
Option.Builder	optionType(OptionType optionType) Sets the key of the option.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

key

public Option.Builder key(String key)

Sets the key of the option.

Parameters:

key - The key of the option.

Returns:

the current builder instance.

addDependecy

public Option.Builder addDependecy(String key)

Adds a key dependency to the option.

Parameters:

key - They key of the option dependency.

Returns:

the current builder instance.

description

public Option.Builder description(String description)

Sets the description of the option.

Parameters:

description - The description of the option.

Returns:

the current builder instance.

optionType

public Option.Builder optionType(OptionType optionType)

Sets the key of the option.

Parameters:

optionType - The optionType of the option.

Returns:

the current builder instance.

isRequired

public Option.Builder isRequired(boolean isRequired)

Sets if the option is required.

Parameters:

isRequired - If the option is required or not.

Returns:

the current builder instance.

isPartnerRequired

public Option.Builder isPartnerRequired(boolean isPartnerRequired)

Sets if the option is required in SteamHost.PARTNER mode.

Parameters:

isPartnerRequired - If the option is required in PARTNER mode.

Returns:

the current builder instance.

build

public Option build()

Builds a new instance of Option with all provided values.

Returns:

the new instance of the option, never null.