OptionParsingCommand (Spring Boot API)

java.lang.Object
- org.springframework.boot.cli.command.AbstractCommand
- - org.springframework.boot.cli.command.OptionParsingCommand

All Implemented Interfaces:
Command
Direct Known Subclasses:
EncodePasswordCommand, GrabCommand, InitCommand, InstallCommand, JarCommand, RunCommand, UninstallCommand, WarCommand
```
public abstract class OptionParsingCommand
extends AbstractCommand
```
Base class for a Command that parse options using an OptionHandler.
See Also:
OptionHandler

Constructor Summary
Constructors
Modifier Constructor Description
protected OptionParsingCommand(String name, String description, OptionHandler handler)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected OptionHandler`	`getHandler()`
`String`	`getHelp()`	Gets full help text for the command, e.g.
`Collection<OptionHelp>`	`getOptionsHelp()`	Returns help for each supported option.
`ExitStatus`	`run(String... args)`	Run the command.

Methods inherited from class org.springframework.boot.cli.command.AbstractCommand
getDescription, getExamples, getName, getUsageHelp

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

- Constructor Detail
  - OptionParsingCommand
```
protected OptionParsingCommand(String name,
                               String description,
                               OptionHandler handler)
```
- Method Detail
  - getHelp
```
public String getHelp()
```
    Description copied from interface: Command
    Gets full help text for the command, e.g. a longer description and one line per option.
    Specified by:
    getHelp in interface Command
    Overrides:
    getHelp in class AbstractCommand
    Returns:
    the command's help text
  - getOptionsHelp
```
public Collection<OptionHelp> getOptionsHelp()
```
    Description copied from interface: Command
    Returns help for each supported option.
    Specified by:
    getOptionsHelp in interface Command
    Overrides:
    getOptionsHelp in class AbstractCommand
    Returns:
    help for each of the command's options
  - run
```
public final ExitStatus run(String... args)
                     throws Exception
```
    Description copied from interface: Command
    Run the command.
    Parameters:
    args - command arguments (this will not include the command itself)
    Returns:
    the outcome of the command
    Throws:
    Exception - if the command fails
  - getHandler
```
protected OptionHandler getHandler()
```