|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.quartercode.quarterbukkit.api.command.CommandInfo
public class CommandInfo
Class for storing some information about a Command
.
Constructor Summary | |
---|---|
CommandInfo(boolean ignoreCase,
java.lang.String parameterUsage,
java.lang.String description,
java.lang.String permission,
java.lang.String... labels)
Creates a new information-object and sets all the information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getDescription()
Returns a short description what the Command does. |
java.lang.String[] |
getLabels()
Returns all labels a user can use for the Command . |
java.lang.String |
getParameterUsage()
Returns how to use the parameters of the Command (returns null if there aren't parameters). |
java.lang.String |
getPermission()
Returns the permission you need to execute the Command . |
int |
hashCode()
|
boolean |
isIgnoreCase()
Returns if the CommandExecutor should ignore the case of the label. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CommandInfo(boolean ignoreCase, java.lang.String parameterUsage, java.lang.String description, java.lang.String permission, java.lang.String... labels)
CommandHandler
s in their CommandHandler.getInfo()
-method.
ignoreCase
- Should the CommandExecutor
ignore the case of the label.parameterUsage
- How to use the parameters of the Command
(null if you can't use parameters).description
- A short description what the Command
does.permission
- The permission you need to execute the Command
.labels
- All labels a user can use for the Command
. If you type in /command help, help will be the label (use <empty> if you want the command can be executed with no label,
e.g. /command). You can define unltimited labels via vararg.Method Detail |
---|
public boolean isIgnoreCase()
CommandExecutor
should ignore the case of the label.
CommandExecutor
should ignore the case of the label.public java.lang.String getParameterUsage()
Command
(returns null if there aren't parameters).
This is useful for help-functions.
Command
.public java.lang.String getDescription()
Command
does.
Command
does.public java.lang.String getPermission()
Command
.
Command
.public java.lang.String[] getLabels()
Command
. If you type in /command help, help will be the label (<empty> if the command can be executed without a label, e.g. /command).
Command
.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |