Package redempt.ordinate.component

Class DescriptionComponent<T>

java.lang.Object

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

redempt.ordinate.component.DescriptionComponent<T>

All Implemented Interfaces:

HelpProvider<T>

public class DescriptionComponent<T>
extends CommandComponent<T>
implements HelpProvider<T>

Constructor Summary

Constructors

Constructor	Description
DescriptionComponent(String description)

Method Summary

Modifier and Type	Method	Description
void	addHelp(HelpBuilder<T> help)
void	addLine(String line)
int	getMaxConsumedArgs()
int	getMaxParsedObjects()
int	getPriority()
CommandResult<T>	parse(CommandContext<T> context)

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

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

DescriptionComponent

public DescriptionComponent(String description)

Method Details

addLine

public void addLine(String line)

getMaxParsedObjects

public int getMaxParsedObjects()

Specified by:

getMaxParsedObjects in class CommandComponent<T>

getMaxConsumedArgs

public int getMaxConsumedArgs()

Specified by:

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