CommandLine (micronaut 3.6.5 API)

```
public interface CommandLine
```
Represents the parsed command line options.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface CommandLine.Builder<T extends CommandLine.Builder>
A build for constructing a command line parser.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CommandLine.Builder<T extends CommandLine.Builder>` A build for constructing a command line parser.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CommandLine.Builder`	`build()` Build and parse a new command line.
`Map<Option,Object>`	`getOptions()`
`String[]`	`getRawArguments()`
`List<String>`	`getRemainingArgs()`
`String`	`getRemainingArgsString()`
`String`	`getRemainingArgsWithOptionsString()`
`Properties`	`getSystemProperties()`
`Map<String,Object>`	`getUndeclaredOptions()`
`boolean`	`hasOption(String name)`
`Map.Entry<String,Object>`	`lastOption()`
`Object`	`optionValue(String name)` The value of an option.
`static CommandLine`	`parse(String... args)` Parse a new command line with the default options.
`CommandLine`	`parseNew(String[] args)` Parses a new `CommandLine` instance that combines this instance with the given arguments.

- Method Detail
  - getRemainingArgs
```
List<String> getRemainingArgs()
```
    Returns:
    
    The remaining arguments after the command name
  - getSystemProperties
```
Properties getSystemProperties()
```
    Returns:
    
    The system properties specified
  - getOptions
```
Map<Option,Object> getOptions()
```
    Returns:
    
    The declared option values
  - hasOption
```
boolean hasOption(String name)
```
    Parameters:
    
    name - The name of the option
    
    Returns:
    
    Whether the given option is specified
  - optionValue
```
Object optionValue(String name)
```
    The value of an option.
    
    Parameters:
    
    name - The option
    
    Returns:
    
    The value
  - lastOption
```
Map.Entry<String,Object> lastOption()
```
    Returns:
    
    The last specified option
  - getRemainingArgsString
```
String getRemainingArgsString()
```
    Returns:
    
    The remaining args as one big string
  - getRemainingArgsWithOptionsString
```
String getRemainingArgsWithOptionsString()
```
    Returns:
    
    The remaining args as one big string without undeclared options
  - getUndeclaredOptions
```
Map<String,Object> getUndeclaredOptions()
```
    Returns:
    
    Any undeclared options
  - parseNew
```
CommandLine parseNew(String[] args)
```
    Parses a new CommandLine instance that combines this instance with the given arguments.
    
    Parameters:
    
    args - The arguments
    
    Returns:
    
    A new CommandLine instance
  - getRawArguments
```
String[] getRawArguments()
```
    Returns:
    
    The raw unparsed arguments
  - build
```
static CommandLine.Builder build()
```
    Build and parse a new command line.
    
    Returns:
    
    The builder
  - parse
```
static CommandLine parse(String... args)
```
    Parse a new command line with the default options.
    
    Parameters:
    
    args - The arguments
    
    Returns:
    
    The command line

Interface CommandLine

Nested Class Summary

Method Summary

Method Detail

getRemainingArgs

getSystemProperties

getOptions

hasOption

optionValue

lastOption

getRemainingArgsString

getRemainingArgsWithOptionsString

getUndeclaredOptions

parseNew

getRawArguments

build

parse