AeshCommandLineParser

java.lang.Object
- org.jboss.aesh.cl.parser.AeshCommandLineParser<C>

All Implemented Interfaces:

CommandLineParser<C>
```
public class AeshCommandLineParser<C extends Command>
extends java.lang.Object
implements CommandLineParser<C>
```
A simple command line parser. It parses a given string based on the Command given and returns a CommandLine It can also print a formatted usage/help information.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<CommandLineParser<? extends Command>>`	`childParsers`
`private static java.lang.String`	`EQUALS`
`private boolean`	`isChild`
`private ProcessedCommand<C>`	`processedCommand`

Constructor Summary

Constructors
Constructor and Description

AeshCommandLineParser(ProcessedCommand<C> processedCommand)

Constructors
Constructor and Description
`AeshCommandLineParser(ProcessedCommand<C> processedCommand)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildParser(CommandLineParser<? extends Command> commandLineParser)`
`private RequiredOptionException`	`checkForMissingRequiredOptions(ProcessedCommand<C> command, CommandLine<? extends Command> commandLine)`
`void`	`clear()`
`boolean`	`equals(java.lang.Object o)`
`private ProcessedOption`	`findLongOption(ProcessedCommand command, java.lang.String line)`
`private ProcessedOption`	`findOption(ProcessedCommand command, java.lang.String line)`
`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()`
`int`	`hashCode()`
`boolean`	`isChild()`
`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 child)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - processedCommand
```
private final ProcessedCommand<C extends Command> processedCommand
```
  - EQUALS
```
private static final java.lang.String EQUALS
```
    See Also:
    
    Constant Field Values
  - childParsers
```
private java.util.List<CommandLineParser<? extends Command>> childParsers
```
  - isChild
```
private boolean isChild
```
- Constructor Detail
  - AeshCommandLineParser
```
public AeshCommandLineParser(ProcessedCommand<C> processedCommand)
```
- Method Detail
  - addChildParser
```
public void addChildParser(CommandLineParser<? extends Command> commandLineParser)
```
    Specified by:
    
    addChildParser in interface CommandLineParser<C extends Command>
  - setChild
```
public void setChild(boolean child)
```
    Specified by:
    
    setChild in interface CommandLineParser<C extends Command>
  - getAllNames
```
public java.util.List<java.lang.String> getAllNames()
```
    Specified by:
    
    getAllNames in interface CommandLineParser<C extends Command>
  - isChild
```
public boolean isChild()
```
  - getChildParser
```
public CommandLineParser<? extends Command> getChildParser(java.lang.String name)
```
    Specified by:
    
    getChildParser in interface CommandLineParser<C extends Command>
    
    Parameters:
    
    name - command
    
    Returns:
    
    child parser that matches the name
  - getAllChildParsers
```
public java.util.List<CommandLineParser<? extends Command>> getAllChildParsers()
```
    Specified by:
    
    getAllChildParsers in interface CommandLineParser<C extends Command>
    
    Returns:
    
    all the child parser
  - getProcessedCommand
```
public ProcessedCommand<C> getProcessedCommand()
```
    Specified by:
    
    getProcessedCommand in interface CommandLineParser<C extends Command>
    
    Returns:
    
    the processed command this parser is generated from
  - getCommand
```
public C getCommand()
```
    Specified by:
    
    getCommand in interface CommandLineParser<C extends Command>
    
    Returns:
    
    the actual command
  - getCompletionParser
```
public CommandLineCompletionParser getCompletionParser()
```
    Specified by:
    
    getCompletionParser in interface CommandLineParser<C extends Command>
    
    Returns:
    
    completion parser created to work on this command
  - getCommandPopulator
```
public CommandPopulator getCommandPopulator()
```
    Specified by:
    
    getCommandPopulator in interface CommandLineParser<C extends Command>
    
    Returns:
    
    command populator to work on this command
  - printHelp
```
public java.lang.String printHelp()
```
    Returns a usage String based on the defined command and options. Useful when printing "help" info etc.
    
    Specified by:
    
    printHelp in interface CommandLineParser<C extends Command>
  - parse
```
public 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.
    
    Specified by:
    
    parse in interface CommandLineParser<C extends Command>
    
    Parameters:
    
    line - input
    
    Returns:
    
    CommandLine
  - parse
```
public CommandLine<? extends Command> parse(AeshLine line,
                                            boolean ignoreRequirements)
```
    Specified by:
    
    parse in interface CommandLineParser<C extends Command>
  - parse
```
public 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.
    
    Specified by:
    
    parse in interface CommandLineParser<C extends Command>
    
    Parameters:
    
    line - input
    
    ignoreRequirements - if we should ignore
    
    Returns:
    
    CommandLine
  - parse
```
public 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.
    
    Specified by:
    
    parse in interface CommandLineParser<C extends Command>
    
    Parameters:
    
    lines - input
    
    ignoreRequirements - if we should ignore
    
    Returns:
    
    CommandLine
  - checkForMissingRequiredOptions
```
private RequiredOptionException checkForMissingRequiredOptions(ProcessedCommand<C> command,
                                                               CommandLine<? extends Command> commandLine)
```
  - findOption
```
private ProcessedOption findOption(ProcessedCommand command,
                                   java.lang.String line)
```
  - findLongOption
```
private ProcessedOption findLongOption(ProcessedCommand command,
                                       java.lang.String line)
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface CommandLineParser<C extends Command>
  - isGroupCommand
```
public boolean isGroupCommand()
```
    Specified by:
    
    isGroupCommand in interface CommandLineParser<C extends Command>
  - 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

Class AeshCommandLineParser<C extends Command>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

processedCommand

EQUALS

childParsers

isChild

Constructor Detail

AeshCommandLineParser

Method Detail

addChildParser

setChild

getAllNames

isChild

getChildParser

getAllChildParsers

getProcessedCommand

getCommand

getCompletionParser

getCommandPopulator

printHelp

parse

parse

parse

parse

checkForMissingRequiredOptions

findOption

findLongOption

clear

isGroupCommand

toString

equals

hashCode