com.sk89q.intake

Class InvalidUsageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sk89q.intake.CommandException

com.sk89q.intake.InvalidUsageException

All Implemented Interfaces:

Serializable

public class InvalidUsageException
extends CommandException

Thrown when a command is not used properly.

When handling this exception, print the error message if it is not null. Print a one line help instruction unless isFullHelpSuggested() is true, which, in that case, the full help of the command should be shown.

If no error message is set and full help is not to be shown, then a generic "you used this command incorrectly" message should be shown.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidUsageException(CommandCallable command) Create a new instance with no error message and with no suggestion that full and complete help for the command should be shown.
InvalidUsageException(String message, CommandCallable command) Create a new instance with a message and with no suggestion that full and complete help for the command should be shown.
InvalidUsageException(String message, CommandCallable command, boolean fullHelpSuggested) Create a new instance with a message.

Method Summary

Modifier and Type	Method and Description
CommandCallable	getCommand() Get the command.
String	getSimpleUsageString(String prefix) Get a simple usage string.
boolean	isFullHelpSuggested() Return whether the full usage of the command should be shown.

Methods inherited from class com.sk89q.intake.CommandException

getCommandUsed, prependStack

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidUsageException

public InvalidUsageException(CommandCallable command)

Create a new instance with no error message and with no suggestion that full and complete help for the command should be shown. This will result in a generic error message.

Parameters:

command - the command

InvalidUsageException

public InvalidUsageException(@Nullable
                             String message,
                             CommandCallable command)

Create a new instance with a message and with no suggestion that full and complete help for the command should be shown.

Parameters:

message - the message

command - the command

InvalidUsageException

public InvalidUsageException(@Nullable
                             String message,
                             CommandCallable command,
                             boolean fullHelpSuggested)

Create a new instance with a message.

Parameters:

message - the message

command - the command

fullHelpSuggested - true if the full help for the command should be shown

Method Detail

getCommand

public CommandCallable getCommand()

Get the command.

Returns:

the command

getSimpleUsageString

public String getSimpleUsageString(String prefix)

Get a simple usage string.

Parameters:

prefix - the command shebang (such as "/") -- may be blank

Returns:

a usage string

isFullHelpSuggested

public boolean isFullHelpSuggested()

Return whether the full usage of the command should be shown.

Returns:

show full usage