Package org.apache.felix.gogo.options
Class Options
java.lang.Object
org.apache.felix.gogo.options.Options
- All Implemented Interfaces:
Option
Yet another GNU long options parser. This one is configured by parsing its Usage string.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String[]
private final String
private String
private PrintStream
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private final String[]
static final String
private boolean
private final Pattern
private static final String
private final String[]
private boolean
private final Pattern
private static final String
private int
private String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
get remaining non-options args as Objects.args()
get remaining non-options args as Strings.static Option
static Option
static Option
static Option
get value of named option.get list of all values for named option.int
get value of named option as a Number.get value of named option as an Object.getObjectList
(String name) get list of all Object values for named option.boolean
test whether specified option has been explicitly set.static void
parse arguments.parse arguments.parse arguments.parse arguments.private void
parse option spec.private void
reset()
setOptionsFirst
(boolean optionsFirst) require options to precede args.setStopOnBadOption
(boolean stopOnBadOption) stop parsing on the first unknown option.toString()
void
usage()
print usage message to System.err.usageError
(String s) prints usage message and returns IllegalArgumentException, for you to throw.
-
Field Details
-
NL
-
regex
- See Also:
-
GROUP_SHORT_OPT_1
private static final int GROUP_SHORT_OPT_1- See Also:
-
GROUP_SHORT_OPT_2
private static final int GROUP_SHORT_OPT_2- See Also:
-
GROUP_LONG_OPT_1
private static final int GROUP_LONG_OPT_1- See Also:
-
GROUP_ARG_1
private static final int GROUP_ARG_1- See Also:
-
GROUP_LONG_OPT_2
private static final int GROUP_LONG_OPT_2- See Also:
-
GROUP_DEFAULT
private static final int GROUP_DEFAULT- See Also:
-
parser
-
uname
-
unmodifiableOptSet
-
unmodifiableOptArg
-
optSet
-
optArg
-
optName
-
optAlias
-
xargs
-
args
-
UNKNOWN
- See Also:
-
usageName
-
usageIndex
private int usageIndex -
spec
-
gspec
-
defOpts
-
defArgs
-
errStream
-
error
-
optionsFirst
private boolean optionsFirst -
stopOnBadOption
private boolean stopOnBadOption
-
-
Constructor Details
-
Options
-
-
Method Details
-
main
-
compile
-
compile
-
compile
-
compile
-
setStopOnBadOption
Description copied from interface:Option
stop parsing on the first unknown option. This allows one parser to get its own options and then pass the remaining options to another parser.- Specified by:
setStopOnBadOption
in interfaceOption
- Parameters:
stopOnBadOption
- stopOnBadOption- Returns:
- Option
-
setOptionsFirst
Description copied from interface:Option
require options to precede args. Default is false, so options can appear between or after args.- Specified by:
setOptionsFirst
in interfaceOption
- Parameters:
optionsFirst
- optionsFirst- Returns:
- Option
-
isSet
Description copied from interface:Option
test whether specified option has been explicitly set. -
getObject
Description copied from interface:Option
get value of named option as an Object. If multiple options given, this method returns the last one. UseOption.getObjectList(String)
to get all values. -
getObjectList
Description copied from interface:Option
get list of all Object values for named option.- Specified by:
getObjectList
in interfaceOption
- Parameters:
name
- the name- Returns:
- List<Object>
-
getList
Description copied from interface:Option
get list of all values for named option. -
addArg
-
get
Description copied from interface:Option
get value of named option. If multiple options given, this method returns the last one. UseOption.getList(String)
to get all values. -
getNumber
Description copied from interface:Option
get value of named option as a Number. -
argObjects
Description copied from interface:Option
get remaining non-options args as Objects.- Specified by:
argObjects
in interfaceOption
- Returns:
- List<Object>
-
args
Description copied from interface:Option
get remaining non-options args as Strings. -
usage
public void usage()Description copied from interface:Option
print usage message to System.err. -
usageError
prints usage message and returns IllegalArgumentException, for you to throw.- Specified by:
usageError
in interfaceOption
- Parameters:
s
- the error- Returns:
- IllegalArgumentException
-
parseSpec
parse option spec. -
reset
private void reset() -
parse
Description copied from interface:Option
parse arguments. SeeOption.parse(List, boolean)
-
parse
Description copied from interface:Option
parse arguments. SeeOption.parse(List, boolean)
-
parse
Description copied from interface:Option
parse arguments. SeeOption.parse(List, boolean)
-
parse
Description copied from interface:Option
parse arguments. If skipArgv0 is true, then parsing begins at arg1. This allows for commands where argv0 is the command name rather than a real argument. -
toString
-