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 java.lang.Object implements ExampleRunnable
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<java.lang.String>
args
TheArguments
annotation allows commands to take in additional arbitrary argumentsprivate boolean
flag
private HelpOption<Simple>
help
The specialHelpOption
provides a-h
and--help
option that can be used to request that help be shown.private java.lang.String
name
Here we declare an option that requires a value by using thearity
field of theOption
annotationprivate int
number
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 Constructor Description Simple()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
main(java.lang.String[] args)
int
run()
Runs the command and returns an exit code that the application should return
-
-
-
Field Detail
-
help
@AirlineModule private HelpOption<Simple> 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 java.lang.String name
Here 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 number
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
-
args
@Arguments private java.util.List<java.lang.String> args
TheArguments
annotation allows commands to take in additional arbitrary arguments
-
-
Method Detail
-
main
public static void main(java.lang.String[] args)
-
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
-
-