Package redempt.ordinate.component.argument

Class OptionalArgumentComponent<T,V>

java.lang.Object

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

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

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

All Implemented Interfaces:

HelpProvider<T>, Named

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

Constructor Summary

Constructors

Constructor	Description
OptionalArgumentComponent(String name, ArgType<T,V> type, ContextProvider<T,V> defaultValue, MessageFormatter<T> invalidError, MessageFormatter<T> contextError)

Method Summary

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

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

complete, getInvalidError, getMaxConsumedArgs, getMaxParsedObjects, getMissingError, getName, getPriority, 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

OptionalArgumentComponent

public OptionalArgumentComponent(String name,
 ArgType<T,V> type,
 ContextProvider<T,V> defaultValue,
 MessageFormatter<T> invalidError,
 MessageFormatter<T> contextError)

Method Details

isOptional

public boolean isOptional()

Overrides:

isOptional in class ArgumentComponent<T,V>

getMinConsumedArgs

public int getMinConsumedArgs()

Overrides:

getMinConsumedArgs in class CommandComponent<T>

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>