jdeserialize

Class Getopt

java.lang.Object

jdeserialize.Getopt

public class Getopt
extends java.lang.Object

Simple getopt()-like implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Getopt.OptionParseException

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	descriptions
private java.util.Map<java.lang.String,java.lang.Integer>	options
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	optvals
private java.util.List<java.lang.String>	otherargs

Constructor Summary

Constructors

Constructor and Description
Getopt() Constructor.
Getopt(java.util.Map<java.lang.String,java.lang.Integer> options, java.util.Map<java.lang.String,java.lang.String> descriptions) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String option, int arguments, java.lang.String description) Add an option to the internal set, including the number of arguments and the description.
java.util.List<java.lang.String>	getArguments(java.lang.String option) Gets the list of arguments for a given option, or null if the option wasn't specified.
java.lang.String	getDescriptionString() Get a tabular description of all options and their descriptions, one per line.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getOptionValues() Gets the set of all options specified, as well as the list of their arguments.
java.util.List<java.lang.String>	getOtherArguments() Gets the list arguments specified that were *not* options or their arguments, in the order they were specified.
boolean	hasOption(java.lang.String opt) Determines whether or not the option was specified when the arguments were parsed.
static void	main(java.lang.String[] args)
void	parse(java.lang.String[] args) Do the parsing/validation.

Methods inherited from class java.lang.Object

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

Field Detail

options

private java.util.Map<java.lang.String,java.lang.Integer> options

otherargs

private java.util.List<java.lang.String> otherargs

descriptions

private java.util.Map<java.lang.String,java.lang.String> descriptions

optvals

private java.util.Map<java.lang.String,java.util.List<java.lang.String>> optvals

Constructor Detail

Getopt

public Getopt(java.util.Map<java.lang.String,java.lang.Integer> options,
              java.util.Map<java.lang.String,java.lang.String> descriptions)

Constructor.

Parameters:

options - Map of options to parse. The key should be an option string (including any initial dashes), and the value should be an Integer representing the number of arguments to parse following the option.

descriptions - Map of option descriptions.

Getopt

public Getopt()

Constructor.

Method Detail

getOtherArguments

public java.util.List<java.lang.String> getOtherArguments()

Gets the list arguments specified that were *not* options or their arguments, in the order they were specified.

Returns:

the list of non-option String arguments

getOptionValues

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getOptionValues()

Gets the set of all options specified, as well as the list of their arguments.

Returns:

a map of all options specified; values are lists of arguments

hasOption

public boolean hasOption(java.lang.String opt)

Determines whether or not the option was specified when the arguments were parsed.

Returns:

true iff the argument was specified (with the correct number of arguments).

getArguments

public java.util.List<java.lang.String> getArguments(java.lang.String option)

Gets the list of arguments for a given option, or null if the option wasn't specified.

Parameters:

option - the option

Returns:

the list of arguments for option

addOption

public void addOption(java.lang.String option,
                      int arguments,
                      java.lang.String description)

Add an option to the internal set, including the number of arguments and the description.

Parameters:

option - option string, including any leading dashes

arguments - number of arguments

description - description of the option

parse

public void parse(java.lang.String[] args)
           throws Getopt.OptionParseException

Do the parsing/validation.

Parameters:

args - arguments to parse

Throws:

Getopt.OptionParseException - if a parse error occurs (the exception message will have details)

getDescriptionString

public java.lang.String getDescriptionString()

Get a tabular description of all options and their descriptions, one per line.

main

public static void main(java.lang.String[] args)