public interface Option
Modifier and Type | Method and Description |
---|---|
List<Object> |
argObjects()
get remaining non-options args as Objects.
|
List<String> |
args()
get remaining non-options args as Strings.
|
String |
get(String name)
get value of named option.
|
List<String> |
getList(String name)
get list of all values for named option.
|
int |
getNumber(String name)
get value of named option as a Number.
|
Object |
getObject(String name)
get value of named option as an Object.
|
List<Object> |
getObjectList(String name)
get list of all Object values for named option.
|
boolean |
isSet(String name)
test whether specified option has been explicitly set.
|
Option |
parse(List<?> argv)
parse arguments.
|
Option |
parse(List<?> argv,
boolean skipArg0)
parse arguments.
|
Option |
parse(Object[] argv)
parse arguments.
|
Option |
parse(Object[] argv,
boolean skipArg0)
parse arguments.
|
Option |
setOptionsFirst(boolean optionsFirst)
require options to precede args.
|
Option |
setStopOnBadOption(boolean stopOnBadOption)
stop parsing on the first unknown option.
|
void |
usage()
print usage message to System.err.
|
IllegalArgumentException |
usageError(String error)
print specified usage error to System.err.
|
Option setStopOnBadOption(boolean stopOnBadOption)
stopOnBadOption
- Option setOptionsFirst(boolean optionsFirst)
optionsFirst
- Option parse(List<?> argv, boolean skipArg0)
argv
- skipArg0
- Option parse(Object[] argv, boolean skipArg0)
#parse(List, boolean)
boolean isSet(String name)
name
- String get(String name)
getList(String)
to get all values.name
- IllegalArgumentException
- if value is not a String.List<String> getList(String name)
name
- IllegalArgumentException
- if all values are not Strings.Object getObject(String name)
getObjectList(String)
to get all values.name
- List<Object> getObjectList(String name)
name
- int getNumber(String name)
name
- IllegalArgumentException
- if argument is not a Number.List<String> args()
IllegalArgumentException
- if args are not Strings.void usage()
IllegalArgumentException usageError(String error)
error
- Copyright © 2006–2023 The Apache Software Foundation. All rights reserved.