Class Simple
java.lang.Object
com.github.rvesse.airline.examples.simple.Simple
- All Implemented Interfaces:
ExampleRunnable
@Command(name="simple",
description="A simple example command")
public class Simple
extends Object
implements ExampleRunnable
-
Field Summary
FieldsModifier and TypeFieldDescriptionTheArguments
annotation allows commands to take in additional arbitrary argumentsprivate boolean
private HelpOption
<Simple> The specialHelpOption
provides a-h
and--help
option that can be used to request that help be shown.private String
Here we declare an option that requires a value by using thearity
field of theOption
annotationprivate int
As we declare this field to be of typeint
Airline will ensure that the value passed to this option can be converted to an integer and throws an error if this is not possible -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
help
The specialHelpOption
provides a-h
and--help
option that can be used to request that help be shown.Developers need to check the
HelpOption.showHelpIfRequested()
method which will display help if requested and returntrue
if the user requested the help -
flag
@Option(name={"-f","--flag"}, description="An option that requires no arguments") private boolean flag -
name
@Option(name={"-n","--name"}, title="Name", arity=1, description="An option that takes an argument") private String nameHere we declare an option that requires a value by using thearity
field of theOption
annotation -
number
@Option(name="--number", title="Number", arity=1, description="An option that takes a numeric argument") private int numberAs we declare this field to be of typeint
Airline will ensure that the value passed to this option can be converted to an integer and throws an error if this is not possible -
args
TheArguments
annotation allows commands to take in additional arbitrary arguments
-
-
Constructor Details
-
Simple
public Simple()
-
-
Method Details
-
main
-
run
public int run()Description copied from interface:ExampleRunnable
Runs the command and returns an exit code that the application should return- Specified by:
run
in interfaceExampleRunnable
- Returns:
- Exit code
-