Package redempt.ordinate.component.argument

Class VariableLengthArgumentComponent<T,V>

java.lang.Object

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

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

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

All Implemented Interfaces:

HelpProvider<T>, Named

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

Constructor Summary

Constructors

Constructor	Description
VariableLengthArgumentComponent(String name, ArgType<T,V> type, boolean optional, 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)
int	getMaxConsumedArgs()
int	getMaxParsedObjects()
int	getMinConsumedArgs()
int	getPriority()
boolean	isOptional()
CommandResult<T>	parse(CommandContext<T> context)

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

getInvalidError, getMissingError, getName, getType, setType

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

VariableLengthArgumentComponent

public VariableLengthArgumentComponent(String name,
 ArgType<T,V> type,
 boolean optional,
 MessageFormatter<T> missingError,
 MessageFormatter<T> invalidError)

Method Details

isOptional

public boolean isOptional()

Overrides:

isOptional in class ArgumentComponent<T,V>

getMaxConsumedArgs

public int getMaxConsumedArgs()

Overrides:

getMaxConsumedArgs in class ArgumentComponent<T,V>

getMinConsumedArgs

public int getMinConsumedArgs()

Overrides:

getMinConsumedArgs in class CommandComponent<T>

getMaxParsedObjects

public int getMaxParsedObjects()

Overrides:

getMaxParsedObjects in class ArgumentComponent<T,V>

getPriority

public int getPriority()

Overrides:

getPriority in class ArgumentComponent<T,V>

parse

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

Overrides:

parse in class ArgumentComponent<T,V>

complete

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

Overrides:

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