Package redempt.ordinate.component.argument

Class ConsumingArgumentComponent<T,V>

java.lang.Object

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

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

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

All Implemented Interfaces:

HelpProvider<T>, Named

public class ConsumingArgumentComponent<T,V>
extends ArgumentComponent<T,V>

Constructor Summary

Constructors

Constructor	Description
ConsumingArgumentComponent(String name, ArgType<T,V> type, boolean optional, ContextProvider<T,V> defaultValue, MessageFormatter<T> missingError, MessageFormatter<T> invalidError, MessageFormatter<T> contextError)

Method Summary

Modifier and Type	Method	Description
void	addHelp(HelpBuilder<T> help)
int	getMaxConsumedArgs()
boolean	isOptional()
CommandResult<T>	parse(CommandContext<T> context)

Methods inherited from class redempt.ordinate.component.argument.ArgumentComponent

complete, getInvalidError, getMaxParsedObjects, getMissingError, getName, getPriority, getType, setType

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

ConsumingArgumentComponent

public ConsumingArgumentComponent(String name,
 ArgType<T,V> type,
 boolean optional,
 ContextProvider<T,V> defaultValue,
 MessageFormatter<T> missingError,
 MessageFormatter<T> invalidError,
 MessageFormatter<T> contextError)

Method Details

isOptional

public boolean isOptional()

Overrides:

isOptional in class ArgumentComponent<T,V>

getMaxConsumedArgs

public int getMaxConsumedArgs()

Overrides:

getMaxConsumedArgs in class ArgumentComponent<T,V>

parse

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

Overrides:

parse in class ArgumentComponent<T,V>

addHelp

public void addHelp(HelpBuilder<T> help)

Specified by:

addHelp in interface HelpProvider<T>

Overrides:

addHelp in class ArgumentComponent<T,V>