org.jboss.aesh.cl

Class CommandLine<T extends Command>

java.lang.Object

org.jboss.aesh.cl.CommandLine<T>

public class CommandLine<T extends Command>
extends java.lang.Object

A parsed String based on the provided CommandDefinition and Options defined in a AeshCommandLineParser. All found options and argument can be queried after.

Field Summary

Fields

Modifier and Type	Field and Description
private ProcessedOption	argument
private java.util.List<ProcessedOption>	options
private CommandLineParser<T>	parser
private boolean	parserError
private CommandLineParserException	parserException

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CommandLine()
	CommandLine(CommandLineParser<T> parser)
	CommandLine(CommandLineParserException parserException)

Method Summary

Modifier and Type	Method and Description
void	addArgumentValue(java.lang.String arg)
void	addOption(ProcessedOption option)
ProcessedOption	getArgument()
ProcessedOption	getOption(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getOptionProperties(java.lang.String name)
java.util.List<ProcessedOption>	getOptions()
java.lang.String	getOptionValue(char c)
java.lang.String	getOptionValue(java.lang.String name)
java.lang.String	getOptionValue(java.lang.String name, java.lang.String fallback)
java.util.List<java.lang.String>	getOptionValues(char c)
java.util.List<java.lang.String>	getOptionValues(java.lang.String name)
java.util.List<java.lang.String>	getOptionValues(java.lang.String name, java.util.List<java.lang.String> fallback)
CommandLineParser<T>	getParser()
CommandLineParserException	getParserException()
boolean	hasOption(char name)
boolean	hasOption(java.lang.String name)
boolean	hasOptionWithOverrideRequired()
boolean	hasParserError()
void	setArgument(ProcessedOption argument)
void	setParserError(boolean error)
void	setParserException(CommandLineParserException e)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

options

private final java.util.List<ProcessedOption> options

argument

private ProcessedOption argument

parserError

private boolean parserError

parserException

private CommandLineParserException parserException

parser

private CommandLineParser<T extends Command> parser

Constructor Detail

CommandLine

private CommandLine()

CommandLine

public CommandLine(CommandLineParser<T> parser)

CommandLine

public CommandLine(CommandLineParserException parserException)

Method Detail

addOption

public void addOption(ProcessedOption option)

getParser

public CommandLineParser<T> getParser()

getOptions

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

addArgumentValue

public void addArgumentValue(java.lang.String arg)

setArgument

public void setArgument(ProcessedOption argument)

getArgument

public ProcessedOption getArgument()

hasOption

public boolean hasOption(char name)

getOption

public ProcessedOption getOption(java.lang.String name)

hasOption

public boolean hasOption(java.lang.String name)

getOptionValue

public java.lang.String getOptionValue(char c)

getOptionValue

public java.lang.String getOptionValue(java.lang.String name)

getOptionValue

public java.lang.String getOptionValue(java.lang.String name,
                                       java.lang.String fallback)

getOptionValues

public java.util.List<java.lang.String> getOptionValues(char c)

getOptionValues

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

getOptionValues

public java.util.List<java.lang.String> getOptionValues(java.lang.String name,
                                                        java.util.List<java.lang.String> fallback)

getOptionProperties

public java.util.Map<java.lang.String,java.lang.String> getOptionProperties(java.lang.String name)

hasParserError

public boolean hasParserError()

setParserError

public void setParserError(boolean error)

getParserException

public CommandLineParserException getParserException()

setParserException

public void setParserException(CommandLineParserException e)

hasOptionWithOverrideRequired

public boolean hasOptionWithOverrideRequired()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object