com.sk89q.intake

Class SettableDescription

java.lang.Object

com.sk89q.intake.SettableDescription

All Implemented Interfaces:

Description

public class SettableDescription
extends Object
implements Description

A simple implementation of Description which has setter methods.

Constructor Summary

Constructors

Constructor and Description
SettableDescription()

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.
void	overrideUsage(String usage) Override the usage string returned with a given one.
void	setDescription(String description) Set the description of the command.
void	setHelp(String help) Set the help text of the command.
void	setParameters(List<Parameter> parameters) Set the list of parameters.
void	setPermissions(List<String> permissions) Set the permissions of this command.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SettableDescription

public SettableDescription()

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

setParameters

public void setParameters(List<Parameter> parameters)

Set the list of parameters.

Parameters:

parameters - the list of parameters

See Also:

getParameters()

getShortDescription

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

setDescription

public void setDescription(String description)

Set the description of the command.

Parameters:

description - the description

See Also:

getShortDescription()

getHelp

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

setHelp

public void setHelp(String help)

Set the help text of the command.

Parameters:

help - the help text

See Also:

getHelp()

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

setPermissions

public void setPermissions(List<String> permissions)

Set the permissions of this command.

Parameters:

permissions - the permissions

overrideUsage

public void overrideUsage(String usage)

Override the usage string returned with a given one.

Parameters:

usage - usage string, or null

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