com.sk89q.intake

Class ImmutableParameter.Builder

java.lang.Object

com.sk89q.intake.ImmutableParameter.Builder

Enclosing class:

ImmutableParameter

public static class ImmutableParameter.Builder
extends Object

Creates instances of ImmutableParameter.

By default, the default value will be an empty list.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ImmutableParameter	build() Create an instance.
List<String>	getDefaultValue() Get the default value as a list of arguments.
String	getName() Get the name of the parameter.
OptionType	getOptionType() Get the type of parameter.
ImmutableParameter.Builder	setDefaultValue(List<String> defaultValue) Set the default value as a list of arguments.
ImmutableParameter.Builder	setName(String name) Set the name of the parameter.
ImmutableParameter.Builder	setOptionType(OptionType optionType) Set the type of parameter.

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

getName

public String getName()

Get the name of the parameter.

Returns:

The name of the parameter

setName

public ImmutableParameter.Builder setName(String name)

Set the name of the parameter.

Parameters:

name - The name of the parameter

Returns:

The builder

getOptionType

public OptionType getOptionType()

Get the type of parameter.

Returns:

The type of parameter

setOptionType

public ImmutableParameter.Builder setOptionType(OptionType optionType)

Set the type of parameter.

Parameters:

optionType - The type of parameter

Returns:

The builder

getDefaultValue

public List<String> getDefaultValue()

Get the default value as a list of arguments.

An empty list implies that there is no default value.

Returns:

The default value (one value) as a list

setDefaultValue

public ImmutableParameter.Builder setDefaultValue(List<String> defaultValue)

Set the default value as a list of arguments.

An empty list implies that there is no default value.

Parameters:

defaultValue - The default value (one value) as a list

Returns:

The builder

build

public ImmutableParameter build()

Create an instance.

Neither name nor optionType can be null.

Returns:

The instance