org.jboss.aesh.cl.internal

Class ProcessedCommand<C extends Command>

java.lang.Object

org.jboss.aesh.cl.internal.ProcessedCommand<C>

public final class ProcessedCommand<C extends Command>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private ProcessedOption	argument
private C	command
private java.lang.String	description
private java.lang.String	name
private java.util.List<ProcessedOption>	options
private CommandPopulator	populator
private ResultHandler	resultHandler
private CommandValidator	validator

Constructor Summary

Constructors

Constructor and Description
ProcessedCommand(java.lang.String name, C command, java.lang.String description, CommandValidator validator, ResultHandler resultHandler, ProcessedOption argument, java.util.List<ProcessedOption> options, CommandPopulator populator)

Method Summary

Modifier and Type	Method and Description
void	addOption(ProcessedOption opt)
void	clear()
boolean	containsArgumentWithDefaultValues()
boolean	equals(java.lang.Object o)
ProcessedOption	findLongOption(java.lang.String name)
ProcessedOption	findLongOptionNoActivatorCheck(java.lang.String name)
ProcessedOption	findOption(java.lang.String name)
ProcessedOption	findOptionNoActivatorCheck(java.lang.String name)
java.util.List<TerminalString>	findPossibleLongNamesWitdDash(java.lang.String name)
private char	findPossibleName(java.lang.String longName)
ProcessedOption	getArgument()
C	getCommand()
CommandPopulator	getCommandPopulator()
java.lang.String	getDescription()
java.lang.String	getName()
java.util.List<TerminalString>	getOptionLongNamesWithDash() Return all option names that not already have a value and is enabled
java.util.List<ProcessedOption>	getOptions()
ResultHandler	getResultHandler()
CommandValidator	getValidator()
boolean	hasArgument()
int	hashCode()
boolean	hasLongOption(java.lang.String optionName)
boolean	hasOptions()
boolean	hasUniqueLongOption(java.lang.String optionName)
java.lang.String	printHelp() Returns a description String based on the defined command and options.
void	setArgument(ProcessedOption argument)
private void	setDescription(java.lang.String description)
private void	setName(java.lang.String name)
private void	setOptions(java.util.List<ProcessedOption> options)
ProcessedOption	startWithLongOption(java.lang.String name)
ProcessedOption	startWithOption(java.lang.String name)
java.lang.String	toString()
void	updateInvocationProviders(InvocationProviders invocationProviders)
void	updateSettings(Settings settings)
private char	verifyThatNamesAreUnique(char name, java.lang.String longName)
private char	verifyThatNamesAreUnique(java.lang.String name, java.lang.String longName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

private java.lang.String name

description

private java.lang.String description

validator

private CommandValidator validator

resultHandler

private ResultHandler resultHandler

populator

private CommandPopulator populator

options

private java.util.List<ProcessedOption> options

argument

private ProcessedOption argument

command

private C extends Command command

Constructor Detail

ProcessedCommand

public ProcessedCommand(java.lang.String name,
                        C command,
                        java.lang.String description,
                        CommandValidator validator,
                        ResultHandler resultHandler,
                        ProcessedOption argument,
                        java.util.List<ProcessedOption> options,
                        CommandPopulator populator)
                 throws OptionParserException

Throws:

OptionParserException

Method Detail

getOptions

public java.util.List<ProcessedOption> getOptions()

addOption

public void addOption(ProcessedOption opt)
               throws OptionParserException

Throws:

OptionParserException

setOptions

private void setOptions(java.util.List<ProcessedOption> options)
                 throws OptionParserException

Throws:

OptionParserException

getName

public java.lang.String getName()

setName

private void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

private void setDescription(java.lang.String description)

getValidator

public CommandValidator getValidator()

getResultHandler

public ResultHandler getResultHandler()

hasArgument

public boolean hasArgument()

getArgument

public ProcessedOption getArgument()

setArgument

public void setArgument(ProcessedOption argument)

getCommandPopulator

public CommandPopulator getCommandPopulator()

getCommand

public C getCommand()

verifyThatNamesAreUnique

private char verifyThatNamesAreUnique(java.lang.String name,
                                      java.lang.String longName)
                               throws OptionParserException

Throws:

OptionParserException

verifyThatNamesAreUnique

private char verifyThatNamesAreUnique(char name,
                                      java.lang.String longName)
                               throws OptionParserException

Throws:

OptionParserException

findPossibleName

private char findPossibleName(java.lang.String longName)
                       throws OptionParserException

Throws:

OptionParserException

findOption

public ProcessedOption findOption(java.lang.String name)

findOptionNoActivatorCheck

public ProcessedOption findOptionNoActivatorCheck(java.lang.String name)

findLongOption

public ProcessedOption findLongOption(java.lang.String name)

findLongOptionNoActivatorCheck

public ProcessedOption findLongOptionNoActivatorCheck(java.lang.String name)

startWithOption

public ProcessedOption startWithOption(java.lang.String name)

startWithLongOption

public ProcessedOption startWithLongOption(java.lang.String name)

clear

public void clear()

getOptionLongNamesWithDash

public java.util.List<TerminalString> getOptionLongNamesWithDash()

Return all option names that not already have a value and is enabled

findPossibleLongNamesWitdDash

public java.util.List<TerminalString> findPossibleLongNamesWitdDash(java.lang.String name)

printHelp

public java.lang.String printHelp()

Returns a description String based on the defined command and options. Useful when printing "help" info etc.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasLongOption

public boolean hasLongOption(java.lang.String optionName)

hasOptions

public boolean hasOptions()

hasUniqueLongOption

public boolean hasUniqueLongOption(java.lang.String optionName)

updateInvocationProviders

public void updateInvocationProviders(InvocationProviders invocationProviders)

updateSettings

public void updateSettings(Settings settings)

containsArgumentWithDefaultValues

public boolean containsArgumentWithDefaultValues()