org.jboss.aesh.cl.parser

Interface CommandLineParser<C extends Command>

All Known Implementing Classes:

AeshCommandLineParser

public interface CommandLineParser<C extends Command>

A command line parser that is created based on a given ProcessedCommand. It must also be able to inject values from a line into a Command object

Method Summary

Modifier and Type	Method and Description
void	addChildParser(CommandLineParser<? extends Command> childParser)
void	clear()
java.util.List<CommandLineParser<? extends Command>>	getAllChildParsers()
java.util.List<java.lang.String>	getAllNames()
CommandLineParser<? extends Command>	getChildParser(java.lang.String name)
C	getCommand()
CommandPopulator	getCommandPopulator()
CommandLineCompletionParser	getCompletionParser()
ProcessedCommand<C>	getProcessedCommand()
boolean	isGroupCommand()
CommandLine<? extends Command>	parse(AeshLine line, boolean ignoreRequirements)
CommandLine<? extends Command>	parse(java.util.List<java.lang.String> lines, boolean ignoreRequirements) Parse a command line with the defined command as base of the rules.
CommandLine<? extends Command>	parse(java.lang.String line) Parse a command line with the defined command as base of the rules.
CommandLine<? extends Command>	parse(java.lang.String line, boolean ignoreRequirements) Parse a command line with the defined command as base of the rules.
java.lang.String	printHelp() Returns a usage String based on the defined command and options.
void	setChild(boolean b)

Method Detail

getProcessedCommand

ProcessedCommand<C> getProcessedCommand()

Returns:

the processed command this parser is generated from

getCommand

C getCommand()

Returns:

the actual command

getCompletionParser

CommandLineCompletionParser getCompletionParser()

Returns:

completion parser created to work on this command

getAllNames

java.util.List<java.lang.String> getAllNames()

getChildParser

CommandLineParser<? extends Command> getChildParser(java.lang.String name)

Parameters:

name - command

Returns:

child parser that matches the name

addChildParser

void addChildParser(CommandLineParser<? extends Command> childParser)

getAllChildParsers

java.util.List<CommandLineParser<? extends Command>> getAllChildParsers()

Returns:

all the child parser

getCommandPopulator

CommandPopulator getCommandPopulator()

Returns:

command populator to work on this command

printHelp

java.lang.String printHelp()

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

parse

CommandLine<? extends Command> parse(java.lang.String line)

Parse a command line with the defined command as base of the rules. If any options are found, but not defined in the command object an CommandLineParserException will be thrown. Also, if a required option is not found or options specified with value, but is not given any value an OptionParserException will be thrown. The options found will be returned as a CommandLine object where they can be queried after.

Parameters:

line - input

Returns:

CommandLine

parse

CommandLine<? extends Command> parse(java.lang.String line,
                                     boolean ignoreRequirements)

Parse a command line with the defined command as base of the rules. If any options are found, but not defined in the command object an CommandLineParserException will be thrown. Also, if a required option is not found or options specified with value, but is not given any value an CommandLineParserException will be thrown. The options found will be returned as a CommandLine object where they can be queried after.

Parameters:

line - input

ignoreRequirements - if we should ignore

Returns:

CommandLine

parse

CommandLine<? extends Command> parse(AeshLine line,
                                     boolean ignoreRequirements)

parse

CommandLine<? extends Command> parse(java.util.List<java.lang.String> lines,
                                     boolean ignoreRequirements)

Parse a command line with the defined command as base of the rules. This method is useful when parsing a command line program thats not in aesh, but rather a standalone command that want to parse input parameters.

Parameters:

lines - input

ignoreRequirements - if we should ignore

Returns:

CommandLine

clear

void clear()

isGroupCommand

boolean isGroupCommand()

setChild

void setChild(boolean b)