Package org.apache.felix.gogo.options
Class Options
- java.lang.Object
-
- org.apache.felix.gogo.options.Options
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Object>
argObjects()
get remaining non-options args as Objects.List<String>
args()
get remaining non-options args as Strings.static Option
compile(String optSpec)
static Option
compile(String[] optSpec)
static Option
compile(String[] optSpec, String[] gspec)
static Option
compile(String[] optSpec, Option gopt)
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.static void
main(String[] args)
Option
parse(Object[] argv)
parse arguments.Option
parse(Object[] argv, boolean skipArg0)
parse arguments.Option
parse(List<?> argv)
parse arguments.Option
parse(List<?> 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.String
toString()
void
usage()
print usage message to System.err.IllegalArgumentException
usageError(String s)
prints usage message and returns IllegalArgumentException, for you to throw.
-
-
-
Field Detail
-
NL
public static final String NL
-
-
Method Detail
-
main
public static void main(String[] args)
-
setStopOnBadOption
public Option setStopOnBadOption(boolean stopOnBadOption)
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
-
setOptionsFirst
public Option setOptionsFirst(boolean optionsFirst)
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
-
isSet
public boolean isSet(String name)
Description copied from interface:Option
test whether specified option has been explicitly set.
-
getObject
public Object getObject(String name)
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
public List<Object> getObjectList(String name)
Description copied from interface:Option
get list of all Object values for named option.- Specified by:
getObjectList
in interfaceOption
- Returns:
-
getList
public List<String> getList(String name)
Description copied from interface:Option
get list of all values for named option.
-
get
public String get(String name)
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
public int getNumber(String name)
Description copied from interface:Option
get value of named option as a Number.
-
argObjects
public List<Object> argObjects()
Description copied from interface:Option
get remaining non-options args as Objects.- Specified by:
argObjects
in interfaceOption
- Returns:
-
args
public List<String> 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
public IllegalArgumentException usageError(String s)
prints usage message and returns IllegalArgumentException, for you to throw.- Specified by:
usageError
in interfaceOption
- Returns:
- IllegalArgumentException
-
parse
public Option parse(Object[] argv)
Description copied from interface:Option
parse arguments.
-
parse
public Option parse(Object[] argv, boolean skipArg0)
Description copied from interface:Option
parse arguments.
-
parse
public Option parse(List<?> argv, boolean skipArg0)
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.
-
-