com.sk89q.intake

Class ImmutableDescription.Builder

java.lang.Object

com.sk89q.intake.ImmutableDescription.Builder

Enclosing class:

ImmutableDescription

public static class ImmutableDescription.Builder
extends Object

Builds instances of ImmutableDescription.

By default, the list of parameters and permissions will be empty lists.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ImmutableDescription	build() Build an instance of the description.
String	getHelp() Get the help text.
List<Parameter>	getParameters() Get the list of parameters.
List<String>	getPermissions() Get a list of permissions.
String	getShortDescription() Get the short description.
String	getUsageOverride() Get the usage override string.
ImmutableDescription.Builder	setHelp(String help) Set the help text.
ImmutableDescription.Builder	setParameters(List<Parameter> parameters) Set the list of parameters.
ImmutableDescription.Builder	setPermissions(List<String> permissions) Set the list of permissions.
ImmutableDescription.Builder	setShortDescription(String shortDescription) Set the short description.
ImmutableDescription.Builder	setUsageOverride(String usageOverride) Set the usage override string.

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

getParameters

public List<Parameter> getParameters()

Get the list of parameters.

Returns:

The list of parameters

setParameters

public ImmutableDescription.Builder setParameters(List<Parameter> parameters)

Set the list of parameters.

Parameters:

parameters - The list of parameters

Returns:

The builder

getPermissions

public List<String> getPermissions()

Get a list of permissions.

Returns:

The list of permissions

setPermissions

public ImmutableDescription.Builder setPermissions(List<String> permissions)

Set the list of permissions.

Parameters:

permissions - The list of permissions

Returns:

The builder

getShortDescription

@Nullable
public String getShortDescription()

Get the short description.

Returns:

The builder

setShortDescription

public ImmutableDescription.Builder setShortDescription(@Nullable
                                                        String shortDescription)

Set the short description.

Parameters:

shortDescription - The short description.

Returns:

The builder

getHelp

@Nullable
public String getHelp()

Get the help text.

Returns:

The help text

setHelp

public ImmutableDescription.Builder setHelp(@Nullable
                                            String help)

Set the help text.

Parameters:

help - The help text

Returns:

The builder

getUsageOverride

@Nullable
public String getUsageOverride()

Get the usage override string.

If null, then usage information will be generated automatically.

Returns:

The usage override

setUsageOverride

public ImmutableDescription.Builder setUsageOverride(@Nullable
                                                     String usageOverride)

Set the usage override string.

If null, then usage information will be generated automatically.

Parameters:

usageOverride - The usage override

Returns:

The builder

build

public ImmutableDescription build()

Build an instance of the description.

Returns:

The description