Package redempt.ordinate.component.argument

Class ArgumentComponent<T,V>

java.lang.Object

redempt.ordinate.component.abstracts.CommandComponent<T>

redempt.ordinate.component.argument.ArgumentComponent<T,V>

All Implemented Interfaces:

HelpProvider<T>, Named

Direct Known Subclasses:

ConsumingArgumentComponent, OptionalArgumentComponent, VariableLengthArgumentComponent

public class ArgumentComponent<T,V>
extends CommandComponent<T>
implements Named, HelpProvider<T>

Constructor Summary

Constructors

Constructor	Description
ArgumentComponent(String name, ArgType<T,V> type, MessageFormatter<T> missingError, MessageFormatter<T> invalidError)

Method Summary

Modifier and Type	Method	Description
void	addHelp(HelpBuilder<T> help)
CommandResult<T>	complete(CommandContext<T> context, Set<String> completions)
MessageFormatter<T>	getInvalidError()
int	getMaxConsumedArgs()
int	getMaxParsedObjects()
MessageFormatter<T>	getMissingError()
String	getName()
int	getPriority()
ArgType<T,V>	getType()
boolean	isOptional()
CommandResult<T>	parse(CommandContext<T> context)
void	setType(ArgType<T,?> type)

Methods inherited from class redempt.ordinate.component.abstracts.CommandComponent

failure, failure, getDepth, getIndex, getMinConsumedArgs, getParent, setIndex, setParent, success

Methods inherited from class java.lang.Object

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

Constructor Details

ArgumentComponent

public ArgumentComponent(String name,
 ArgType<T,V> type,
 MessageFormatter<T> missingError,
 MessageFormatter<T> invalidError)

Method Details

isOptional

public boolean isOptional()

getInvalidError

public MessageFormatter<T> getInvalidError()

getMissingError

public MessageFormatter<T> getMissingError()

getType

public ArgType<T,V> getType()

setType

public void setType(ArgType<T,?> type)

getMaxConsumedArgs

public int getMaxConsumedArgs()

Specified by:

getMaxConsumedArgs in class CommandComponent<T>

getMaxParsedObjects

public int getMaxParsedObjects()

Specified by:

getMaxParsedObjects in class CommandComponent<T>

getPriority

public int getPriority()

Specified by:

getPriority in class CommandComponent<T>

addHelp

public void addHelp(HelpBuilder<T> help)

Specified by:

addHelp in interface HelpProvider<T>

parse

public CommandResult<T> parse(CommandContext<T> context)

Specified by:

parse in class CommandComponent<T>

complete

public CommandResult<T> complete(CommandContext<T> context,
 Set<String> completions)

Overrides:

complete in class CommandComponent<T>

getName

public String getName()

Specified by:

getName in interface Named