Package org.jline.builtins

Class Options

java.lang.Object

org.jline.builtins.Options

public class Options
extends Object

A GNU-style long options parser that is configured by parsing its usage string.

This class provides a flexible command-line option parser that supports both short options (-a) and long options (--option), with or without arguments. The parser is configured by parsing a usage string that describes the available options and their arguments.

Features include:

• Support for both short (-a) and long (--option) options
• Required and optional option arguments
• Automatic generation of help text
• Support for subcommands
• Type conversion for option arguments

Code originally from Apache Felix Gogo Shell, adapted for JLine.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Options.HelpException	Exception thrown when using the --help option on a built-in command.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	args
private final String[]	defArgs
private final String	defOpts
private String	error
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 static final Pattern	parser
private static final String	regex
private final String[]	spec
private boolean	stopOnBadOption
private static 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, Options opt, Function<String,String> env)

Method Summary

Modifier and Type	Method	Description
private void	addArg(String name, Object value)
List<Object>	argObjects()
List<String>	args()
static Options	compile(String optSpec)
static Options	compile(String[] optSpec)
static Options	compile(String[] optSpec, String[] gspec)
static Options	compile(String[] optSpec, Function<String,String> env)
static Options	compile(String[] optSpec, Options gopt)
static Options	compile(String optSpec, Function<String,String> env)
String	get(String name)
List<String>	getList(String name)
int	getNumber(String name)
Object	getObject(String name)
List<Object>	getObjectList(String name)
boolean	isSet(String name)
Options	parse(Object[] argv)
Options	parse(Object[] argv, boolean skipArg0)
Options	parse(List<?> argv)
Options	parse(List<?> argv, boolean skipArg0)
private void	parseSpec(Map<String,Boolean> myOptSet, Map<String,Object> myOptArg)	parse option spec.
private void	reset()
Options	setOptionsFirst(boolean optionsFirst)
Options	setStopOnBadOption(boolean stopOnBadOption)
String	toString()
String	usage()
void	usage(PrintStream err)
IllegalArgumentException	usageError(String s)	Prints usage message and returns IllegalArgumentException, for you to throw.

Methods inherited from class java.lang.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 static final Pattern parser

uname

private static 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

error

private String error

optionsFirst

private boolean optionsFirst

stopOnBadOption

private boolean stopOnBadOption

Constructor Details

Options

private Options(String[] spec,
 String[] gspec,
 Options opt,
 Function<String,String> env)

Method Details

compile

public static Options compile(String[] optSpec)

compile

public static Options compile(String[] optSpec,
 Function<String,String> env)

compile

public static Options compile(String optSpec)

compile

public static Options compile(String optSpec,
 Function<String,String> env)

compile

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

compile

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

setStopOnBadOption

public Options setStopOnBadOption(boolean stopOnBadOption)

setOptionsFirst

public Options setOptionsFirst(boolean optionsFirst)

isSet

public boolean isSet(String name)

getObject

public Object getObject(String name)

getObjectList

public List<Object> getObjectList(String name)

getList

public List<String> getList(String name)

addArg

private void addArg(String name,
 Object value)

get

public String get(String name)

getNumber

public int getNumber(String name)

argObjects

public List<Object> argObjects()

args

public List<String> args()

usage

public void usage(PrintStream err)

usage

public String usage()

usageError

public IllegalArgumentException usageError(String s)

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

Parameters:

s - the message to display

Returns:

an exception with the generated message

parseSpec

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

parse option spec.

reset

private void reset()

parse

public Options parse(Object[] argv)

parse

public Options parse(List<?> argv)

parse

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

parse

public Options parse(List<?> argv,
 boolean skipArg0)

toString

public String toString()

Overrides:

toString in class Object