Package org.core.command.argument.arguments.operation

Class OptionalArgument<T>

java.lang.Object

org.core.command.argument.arguments.operation.OptionalArgument<T>

All Implemented Interfaces:

CommandArgument<T>, ParseCommandArgument<T>, SuggestCommandArgument<T>

Direct Known Subclasses:

SourceOrLivePlayerArgument

public class OptionalArgument<T>
extends Object
implements CommandArgument<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptionalArgument.WrappedParser<T>

Constructor Summary

Constructors

Constructor	Description
OptionalArgument(CommandArgument<T> arg, ParseCommandArgument<T> value)
OptionalArgument(CommandArgument<T> arg, T value)

Method Summary

Modifier and Type	Method	Description
String	getId()	Gets the ID of the command argument.
CommandArgument<T>	getOriginalArgument()
String	getUsage()	Gets the usage of the argument
CommandArgumentResult<T>	parse(CommandContext context, CommandArgumentContext<T> argument)
Collection<String>	suggest(CommandContext commandContext, CommandArgumentContext<T> argument)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.core.command.argument.SuggestCommandArgument

errorMessage

Constructor Details

OptionalArgument

public OptionalArgument(CommandArgument<T> arg,
 T value)

OptionalArgument

public OptionalArgument(CommandArgument<T> arg,
 ParseCommandArgument<T> value)

Method Details

getId

public String getId()

Description copied from interface: CommandArgument

Gets the ID of the command argument. A command argument id needs to be unique within the command, the ID is what separates the arguments. There isn't a standard message structure, however by default the id will be what shows in the usage

Specified by:

getId in interface CommandArgument<T>

Returns:

a string Id

getUsage

public String getUsage()

Description copied from interface: CommandArgument

Gets the usage of the argument

Specified by:

getUsage in interface CommandArgument<T>

Returns:

a string version of the usage of the argument

getOriginalArgument

public CommandArgument<T> getOriginalArgument()

parse

public CommandArgumentResult<T> parse(CommandContext context,
 CommandArgumentContext<T> argument)
                               throws IOException

Specified by:

parse in interface ParseCommandArgument<T>

Throws:

IOException

suggest

public Collection<String> suggest(CommandContext commandContext,
 CommandArgumentContext<T> argument)
                           throws NotEnoughArguments

Specified by:

suggest in interface SuggestCommandArgument<T>

Throws:

NotEnoughArguments