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

Class SuggestionArgument<A>

java.lang.Object

org.core.command.argument.arguments.operation.SuggestionArgument<A>

All Implemented Interfaces:

CommandArgument<A>, ParseCommandArgument<A>, SuggestCommandArgument<A>

public abstract class SuggestionArgument<A>
extends Object
implements CommandArgument<A>

Field Summary

Fields

Modifier and Type	Field	Description
protected ParseCommandArgument<A>	argument
protected String	id

Constructor Summary

Constructors

Constructor	Description
SuggestionArgument(String id, ParseCommandArgument<A> argument)
SuggestionArgument(CommandArgument<A> argument)

Method Summary

Modifier and Type	Method	Description
String	getId()	Gets the ID of the command argument.
CommandArgumentResult<A>	parse(CommandContext context, CommandArgumentContext<A> 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.CommandArgument

getUsage

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

errorMessage, suggest

Field Details

argument

protected final ParseCommandArgument<A> argument

id

protected final String id

Constructor Details

SuggestionArgument

public SuggestionArgument(CommandArgument<A> argument)

SuggestionArgument

public SuggestionArgument(String id,
 ParseCommandArgument<A> argument)

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<A>

Returns:

a string Id

parse

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

Specified by:

parse in interface ParseCommandArgument<A>

Throws:

IOException