Class Options

java.lang.Object

org.apache.felix.gogo.options.Options

All Implemented Interfaces:

Option

public class Options
extends Object
implements Option

Yet another GNU long options parser. This one is configured by parsing its Usage string.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	args
private final String[]	defArgs
private final String	defOpts
private String	error
private PrintStream	errStream
private static final int	GROUP_ARG_1
private static final int	GROUP_DEFAULT
private static final int	GROUP_LONG_OPT_1
private static final int	GROUP_LONG_OPT_2
private static final int	GROUP_SHORT_OPT_1
private static final int	GROUP_SHORT_OPT_2
private final String[]	gspec
static final String	NL
private final Map<String,String>	optAlias
private final Map<String,Object>	optArg
private boolean	optionsFirst
private final Map<String,String>	optName
private final Map<String,Boolean>	optSet
private final Pattern	parser
private static final String	regex
private final String[]	spec
private boolean	stopOnBadOption
private final Pattern	uname
private static final String	UNKNOWN
private final Map<String,Object>	unmodifiableOptArg
private final Map<String,Boolean>	unmodifiableOptSet
private int	usageIndex
private String	usageName
private final List<Object>	xargs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Options(String[] spec, String[] gspec, Option opt)

Method Summary

Modifier and Type	Method	Description
private void	addArg(String name, Object value)
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.
private void	parseSpec(Map<String,Boolean> myOptSet, Map<String,Object> myOptArg)	parse option spec.
private void	reset()
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NL

public static final String NL

regex

private static final String regex

See Also:

• Constant Field Values

GROUP_SHORT_OPT_1

private static final int GROUP_SHORT_OPT_1

See Also:

• Constant Field Values

GROUP_SHORT_OPT_2

private static final int GROUP_SHORT_OPT_2

See Also:

• Constant Field Values

GROUP_LONG_OPT_1

private static final int GROUP_LONG_OPT_1

See Also:

• Constant Field Values

GROUP_ARG_1

private static final int GROUP_ARG_1

See Also:

• Constant Field Values

GROUP_LONG_OPT_2

private static final int GROUP_LONG_OPT_2

See Also:

• Constant Field Values

GROUP_DEFAULT

private static final int GROUP_DEFAULT

See Also:

• Constant Field Values

parser

private final Pattern parser

uname

private final Pattern uname

unmodifiableOptSet

private final Map<String,Boolean> unmodifiableOptSet

unmodifiableOptArg

private final Map<String,Object> unmodifiableOptArg

optSet

private final Map<String,Boolean> optSet

optArg

private final Map<String,Object> optArg

optName

private final Map<String,String> optName

optAlias

private final Map<String,String> optAlias

xargs

private final List<Object> xargs

args

private List<String> args

UNKNOWN

private static final String UNKNOWN

See Also:

• Constant Field Values

usageName

private String usageName

usageIndex

private int usageIndex

spec

private final String[] spec

gspec

private final String[] gspec

defOpts

private final String defOpts

defArgs

private final String[] defArgs

errStream

private PrintStream errStream

error

private String error

optionsFirst

private boolean optionsFirst

stopOnBadOption

private boolean stopOnBadOption

Constructor Details

Options

private Options(String[] spec,
 String[] gspec,
 Option opt)

Method Details

main

public static void main(String[] args)

compile

public static Option compile(String[] optSpec)

compile

public static Option compile(String optSpec)

compile

public static Option compile(String[] optSpec,
 Option gopt)

compile

public static Option compile(String[] optSpec,
 String[] gspec)

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 interface Option

Parameters:

stopOnBadOption - stopOnBadOption

Returns:

Option

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 interface Option

Parameters:

optionsFirst - optionsFirst

Returns:

Option

isSet

public boolean isSet(String name)

Description copied from interface: Option

test whether specified option has been explicitly set.

Specified by:

isSet in interface Option

Parameters:

name - name

Returns:

boolean

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. Use Option.getObjectList(String) to get all values.

Specified by:

getObject in interface Option

Parameters:

name - the name

Returns:

Object

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 interface Option

Parameters:

name - the name

Returns:

List<Object>

getList

public List<String> getList(String name)

Description copied from interface: Option

get list of all values for named option.

Specified by:

getList in interface Option

Parameters:

name - the name

Returns:

empty list if option not given and no default specified.

addArg

private void addArg(String name,
 Object value)

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. Use Option.getList(String) to get all values.

Specified by:

get in interface Option

Parameters:

name - the name

Returns:

String

getNumber

public int getNumber(String name)

Description copied from interface: Option

get value of named option as a Number.

Specified by:

getNumber in interface Option

Parameters:

name - the name

Returns:

int

argObjects

public List<Object> argObjects()

Description copied from interface: Option

get remaining non-options args as Objects.

Specified by:

argObjects in interface Option

Returns:

List<Object>

args

public List<String> args()

Description copied from interface: Option

get remaining non-options args as Strings.

Specified by:

args in interface Option

Returns:

List<String>

usage

public void usage()

Description copied from interface: Option

print usage message to System.err.

Specified by:

usage in interface Option

usageError

public IllegalArgumentException usageError(String s)

prints usage message and returns IllegalArgumentException, for you to throw.

Specified by:

usageError in interface Option

Parameters:

s - the error

Returns:

IllegalArgumentException

parseSpec

private void parseSpec(Map<String,Boolean> myOptSet,
 Map<String,Object> myOptArg)

parse option spec.

reset

private void reset()

parse

public Option parse(Object[] argv)

Description copied from interface: Option

parse arguments. See Option.parse(List, boolean)

Specified by:

parse in interface Option

Parameters:

argv - argv

Returns:

Option

parse

public Option parse(List<?> argv)

Description copied from interface: Option

parse arguments. See Option.parse(List, boolean)

Specified by:

parse in interface Option

Parameters:

argv - the arg

Returns:

Option

parse

public Option parse(Object[] argv,
 boolean skipArg0)

Description copied from interface: Option

parse arguments. See Option.parse(List, boolean)

Specified by:

parse in interface Option

Parameters:

argv - the arg

skipArg0 - skipArg0

Returns:

Option

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.

Specified by:

parse in interface Option

Parameters:

argv - argv

skipArg0 - skipArg0

Returns:

Option

toString

public String toString()

Overrides:

toString in class Object