public class SimpleDescription extends java.lang.Object implements Description
Description
which has setters.Constructor and Description |
---|
SimpleDescription() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getHelp()
Get a longer help text about this command.
|
java.util.List<Parameter> |
getParameters()
Get the list of parameters for this command.
|
java.util.List<java.lang.String> |
getPermissions()
Get a list of permissions that the player may have to have permission.
|
java.lang.String |
getShortDescription()
Get a short one-line description of this command.
|
java.lang.String |
getUsage()
Get the usage string of this command.
|
void |
overrideUsage(java.lang.String usage)
Override the usage string returned with a given one.
|
void |
setDescription(java.lang.String description)
Set the description of the command.
|
void |
setHelp(java.lang.String help)
Set the help text of the command.
|
void |
setParameters(java.util.List<Parameter> parameters)
Set the list of parameters.
|
void |
setPermissions(java.util.List<java.lang.String> permissions)
Set the permissions of this command.
|
java.lang.String |
toString() |
public java.util.List<Parameter> getParameters()
Description
getParameters
in interface Description
public void setParameters(java.util.List<Parameter> parameters)
parameters
- the list of parametersgetParameters()
public java.lang.String getShortDescription()
Description
getShortDescription
in interface Description
public void setDescription(java.lang.String description)
description
- the descriptiongetShortDescription()
public java.lang.String getHelp()
Description
getHelp
in interface Description
public void setHelp(java.lang.String help)
help
- the help textgetHelp()
public java.util.List<java.lang.String> getPermissions()
Description
Permission data may or may not be available. This is only useful as a potential hint.
getPermissions
in interface Description
public void setPermissions(java.util.List<java.lang.String> permissions)
permissions
- the permissionspublic void overrideUsage(java.lang.String usage)
usage
- usage string, or nullpublic java.lang.String getUsage()
Description
A usage string may look like
[-w <world>] <var1> <var2>
.
getUsage
in interface Description
public java.lang.String toString()
toString
in class java.lang.Object