Package org.core.command.argument.arguments.id

Class IdentifiableArgument<I extends Identifiable>

java.lang.Object

org.core.command.argument.arguments.id.IdentifiableArgument<I>

Type Parameters:

I - The return class type of the argument

All Implemented Interfaces:

CommandArgument<I>, ParseCommandArgument<I>, SuggestCommandArgument<I>

Direct Known Subclasses:

BlockGroupArgument, BlockTypeArgument

public abstract class IdentifiableArgument<I extends Identifiable>
extends Object
implements CommandArgument<I>

Gets a single identifiable object from the collection provided by getAll()

Constructor Summary

Constructors

Constructor	Description
IdentifiableArgument(String id)

Method Summary

Modifier and Type	Method	Description
abstract Collection<I>	getAll()	Gets all possible values that the argument could be
String	getId()	Gets the ID of the command argument.
CommandArgumentResult<I>	parse(CommandContext context, CommandArgumentContext<I> argument)
Set<String>	suggest(CommandContext context, CommandArgumentContext<I> 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

IdentifiableArgument

public IdentifiableArgument(String id)

Method Details

getAll

public abstract Collection<I> getAll()

Gets all possible values that the argument could be

Returns:

A collection of all possible values

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<I extends Identifiable>

Returns:

a string Id

parse

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

Specified by:

parse in interface ParseCommandArgument<I extends Identifiable>

Throws:

IOException

suggest

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

Specified by:

suggest in interface SuggestCommandArgument<I extends Identifiable>