jasm.util

Class OptArg

java.lang.Object

jasm.util.OptArg

public final class OptArg
extends Object

A small utility for parsing command-line options. It helps to take some of the hassle out of building the front-end of a Whiley compiler.

Author:

David J. Pearce

Field Summary

Fields

Modifier and Type	Field and Description
jasm.util.OptArg.Kind	argument The kind of argument accepted by this option (if any).
Object	defaultValue A default value for the option (assuming it accepts an argument).
String	description A description of the option.
static jasm.util.OptArg.FILE	FILE
static jasm.util.OptArg.FILEDIR	FILEDIR
static jasm.util.OptArg.FILELIST	FILELIST
static jasm.util.OptArg.INT	INT
String	option The long form of the option.
String	shortForm The short form of the option.
static jasm.util.OptArg.STRING	STRING

Constructor Summary

Constructors

Constructor and Description
OptArg(String option, jasm.util.OptArg.Kind argument, String description) Construct an option object which accepts an argument.
OptArg(String option, jasm.util.OptArg.Kind argument, String description, Object defaultValue) Construct an option object which accepts an argument and has a default value.
OptArg(String option, String description) Construct an option object which does not accept an argument.
OptArg(String option, String shortForm, jasm.util.OptArg.Kind argument, String description) Construct an option object with a short form which accepts an argument.
OptArg(String option, String shortForm, jasm.util.OptArg.Kind argument, String description, Object defaultValue) Construct an option object with a short form which accepts an argument and has a default value.
OptArg(String option, String shortForm, String description) Construct an option object with a short form which does not accept an argument.

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	parseOptions(List<String> args, OptArg... options) Parse options from the list of arguments, removing those which are recognised.
static void	usage(PrintStream output, OptArg... options)

Methods inherited from class java.lang.Object

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

Field Detail

option

public final String option

The long form of the option. (e.g. for "-version", the long form is "version")

shortForm

public final String shortForm

The short form of the option. (e.g. for "-version", the short form might be "v" as in "-v")

argument

public final jasm.util.OptArg.Kind argument

The kind of argument accepted by this option (if any).

description

public final String description

A description of the option. This is used when printing out "usage" information.

defaultValue

public final Object defaultValue

A default value for the option (assuming it accepts an argument). This may be null if there is no default value.

STRING

public static final jasm.util.OptArg.STRING STRING

INT

public static final jasm.util.OptArg.INT INT

FILE

public static final jasm.util.OptArg.FILE FILE

FILEDIR

public static final jasm.util.OptArg.FILEDIR FILEDIR

FILELIST

public static final jasm.util.OptArg.FILELIST FILELIST

Constructor Detail

OptArg

public OptArg(String option,
              String description)

Construct an option object which does not accept an argument.

Parameters:

option - Long form of option (e.g. "version" for "-version").

description - Description of the option.

OptArg

public OptArg(String option,
              String shortForm,
              String description)

Construct an option object with a short form which does not accept an argument.

Parameters:

option - Long form of option (e.g. "version" for "-version").

shortForm - Short form of the option (e.g. "v" for "-v").

description - Description of the option used for printing usage information.

OptArg

public OptArg(String option,
              jasm.util.OptArg.Kind argument,
              String description)

Construct an option object which accepts an argument.

Parameters:

option - Long form of option (e.g. "version" for "-version").

argument - Kind of argument accepted by this option (if any).

description - Description of the option used for printing usage information.

OptArg

public OptArg(String option,
              String shortForm,
              jasm.util.OptArg.Kind argument,
              String description)

Construct an option object with a short form which accepts an argument.

Parameters:

option - Long form of option (e.g. "version" for "-version").

shortForm - Short form of the option (e.g. "v" for "-v").

argument - Kind of argument accepted by this option (if any).

description - Description of the option used for printing usage information.

OptArg

public OptArg(String option,
              jasm.util.OptArg.Kind argument,
              String description,
              Object defaultValue)

Construct an option object which accepts an argument and has a default value.

Parameters:

option - Long form of option (e.g. "version" for "-version").

argument - Kind of argument accepted by this option (if any).

description - Description of the option used for printing usage information.

defaultValue. - Default value of argument, or null if no default value.

OptArg

public OptArg(String option,
              String shortForm,
              jasm.util.OptArg.Kind argument,
              String description,
              Object defaultValue)

Construct an option object with a short form which accepts an argument and has a default value.

Parameters:

option - Long form of option (e.g. "version" for "-version").

shortForm - Short form of the option (e.g. "v" for "-v").

argument - Kind of argument accepted by this option (if any).

description - Description of the option used for printing usage information.

defaultValue. - Default value of argument, or null if no default value.

Method Detail

parseOptions

public static Map<String,Object> parseOptions(List<String> args,
                                              OptArg... options)

Parse options from the list of arguments, removing those which are recognised. Anything which is not recognised is left as is. Throws RuntimeException if an unrecognised option is encountered (that is, a token starting with '-').

Parameters:

args - --- the list of argument strings. This is modified by removing those which are processed.

options - --- the list of OptArg defining which options should be processed

usage

public static void usage(PrintStream output,
                         OptArg... options)