Package org.core.command.argument.arguments.simple

Class StringArgument

java.lang.Object

org.core.command.argument.arguments.simple.StringArgument

All Implemented Interfaces:

CommandArgument<String>, ParseCommandArgument<String>, SuggestCommandArgument<String>

public class StringArgument
extends Object
implements CommandArgument<String>

Constructor Summary

Constructors

Constructor	Description
StringArgument(String id)

Method Summary

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

Constructor Details

StringArgument

public StringArgument(String id)

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

Returns:

a string Id

parse

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

Specified by:

parse in interface ParseCommandArgument<String>

Throws:

IOException

suggest

public Set<String> suggest(CommandContext commandContext,
 CommandArgumentContext<String> argument)

Specified by:

suggest in interface SuggestCommandArgument<String>