com.sk89q.intake

Class ImmutableDescription

java.lang.Object

com.sk89q.intake.ImmutableDescription

All Implemented Interfaces:

Description

public final class ImmutableDescription
extends Object
implements Description

An immutable implementation of a Description.

Use ImmutableDescription.Builder to create instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableDescription.Builder Builds instances of ImmutableDescription.

Method Summary

Modifier and Type	Method and Description
String	getHelp() Get a longer help text about this command.
List<Parameter>	getParameters() Get the list of parameters for this command.
List<String>	getPermissions() Get a list of permissions that the player may have to have permission.
String	getShortDescription() Get a short one-line description of this command.
String	getUsage() Get the usage string of this command.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getParameters

public List<Parameter> getParameters()

Description copied from interface: Description

Get the list of parameters for this command.

Specified by:

getParameters in interface Description

Returns:

A list of parameters

getShortDescription

@Nullable
public String getShortDescription()

Description copied from interface: Description

Get a short one-line description of this command.

Specified by:

getShortDescription in interface Description

Returns:

A description, or null if no description is available

getHelp

@Nullable
public String getHelp()

Description copied from interface: Description

Get a longer help text about this command.

Specified by:

getHelp in interface Description

Returns:

A help text, or null if no help is available

getPermissions

public List<String> getPermissions()

Description copied from interface: Description

Get a list of permissions that the player may have to have permission.

Permission data may or may not be available. This is only useful as a potential hint.

Specified by:

getPermissions in interface Description

Returns:

The list of permissions

getUsage

public String getUsage()

Description copied from interface: Description

Get the usage string of this command.

A usage string may look like [-w <world>] <var1> <var2>.

Specified by:

getUsage in interface Description

Returns:

A usage string

toString

public String toString()

Overrides:

toString in class Object