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
static final String	NL

Method Summary

Modifier and Type	Method	Description
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)
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

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)

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

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