Modifier and Type	Class and Description
pack-priv static class	OptionScanner.LongSpec Class representing an argument of the long type, where the whole program argument represents one option, e.g. "--help" or "-version".

Field Summary

Modifier and Type	Field and Description
private int	argIndex Index in argv of the arg currently being processed (or about to be started).
private String[]	args Original argv passed at reset
pack-priv static final char	ARGUMENT Return to indicate the next argument is a free-standing argument.
pack-priv static final char	DONE Return to indicate argument processing is over.
pack-priv static final char	ERROR Return to indicate option was not recognised.
private final OptionScanner.LongSpec[]	longSpec
private String	message Error message (after returning `ERROR`.
private String	optarg Option argument (where present for returned option).
private int	optIndex Character index within the current element of argv (of the next option to process).
private final String	programOpts Valid options.

Constructor Summary

Access	Constructor and Description
pack-priv	OptionScanner(String[] command-line arguments (which must not change during scanning) args, String the one-letter options (with : indicating an option argument programOpts, OptionScanner.LongSpec[] table of long options (like --help) longSpec) Create the scanner from command-line arguments, and information about the valid options.

Method Summary

Modifier and Type	Method and Description
pack-priv int	countRemainingArguments() Number of arguments that remain unprocessed from the original array.
pack-priv char	error(String message, Object... args) Set the error message as `String.format(message, args)` and return `ERROR`.
pack-priv String	getMessage() Get the error message (when we previously returned `ERROR`.
pack-priv char	Returns: next option from command line: the actual character or a code. getOption() Get the next option (as a character), or return a code designating successful or erroneous completion.
pack-priv String	getOptionArgument() Get the argument of the previously returned option or `null` if none.
pack-priv String	getWholeArgument() Get a whole argument (not the argument of an option), for use after `ARGUMENT` was returned.
pack-priv String	peekWholeArgument() Peek at a whole argument (not the argument of an option), for use after `ARGUMENT` was returned.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argIndex	back to summary
private int argIndex Index in argv of the arg currently being processed (or about to be started).

args	back to summary
private String[] args Original argv passed at reset

ARGUMENT	back to summary
pack-priv static final char ARGUMENT Return to indicate the next argument is a free-standing argument.

DONE	back to summary
pack-priv static final char DONE Return to indicate argument processing is over.

ERROR	back to summary
pack-priv static final char ERROR Return to indicate option was not recognised.

longSpec	back to summary
private final OptionScanner.LongSpec[] longSpec

message	back to summary
private String message Error message (after returning `ERROR`.

optarg	back to summary
private String optarg Option argument (where present for returned option).

optIndex	back to summary
private int optIndex Character index within the current element of argv (of the next option to process).

programOpts	back to summary
private final String programOpts Valid options. ':' means expect an argument following.

Constructor Detail

OptionScanner	back to summary
pack-priv OptionScanner(String[] args, String programOpts, OptionScanner.LongSpec[] longSpec) Create the scanner from command-line arguments, and information about the valid options. Parameters args:String[] command-line arguments (which must not change during scanning) programOpts:String the one-letter options (with : indicating an option argument longSpec:OptionScanner.LongSpec[] table of long options (like --help)

OptionScanner

back to summary

pack-priv OptionScanner(String[] args, String programOpts, OptionScanner.LongSpec[] longSpec)

Create the scanner from command-line arguments, and information about the valid options.

Parameters

args:String[]: command-line arguments (which must not change during scanning)
programOpts:String: the one-letter options (with : indicating an option argument
longSpec:OptionScanner.LongSpec[]: table of long options (like --help)

Method Detail

countRemainingArguments	back to summary
pack-priv int countRemainingArguments() Number of arguments that remain unprocessed from the original array.

error	back to summary
pack-priv char error(String message, Object... args) Set the error message as `String.format(message, args)` and return `ERROR`.

getMessage	back to summary
pack-priv String getMessage() Get the error message (when we previously returned `ERROR`.

getOption	back to summary
pack-priv char getOption() Get the next option (as a character), or return a code designating successful or erroneous completion. Returns:char next option from command line: the actual character or a code.

getOption

back to summary

pack-priv char getOption()

Get the next option (as a character), or return a code designating successful or erroneous completion.

Returns:char: next option from command line: the actual character or a code.

getOptionArgument	back to summary
pack-priv String getOptionArgument() Get the argument of the previously returned option or `null` if none.

getWholeArgument	back to summary
pack-priv String getWholeArgument() Get a whole argument (not the argument of an option), for use after `ARGUMENT` was returned. This advances the internal state to the next argument.

peekWholeArgument	back to summary
pack-priv String peekWholeArgument() Peek at a whole argument (not the argument of an option), for use after `ARGUMENT` was returned. This does not advance the internal state to the next argument.

org.python.util back to summary

pack-priv Class OptionScanner.LongSpec

Class Inheritance

extends Object

java.lang.Object
org.python.util.OptionScanner.LongSpec

Class representing an argument of the long type, where the whole program argument represents one option, e.g. "--help" or "-version". Such options must start with a '-'. The client supplies an array of LongSpec objects to the constructor to define the valid cases. Long options are recognised before single-letter options are looked for. Note that "-" itself is treated as a long option (even though it is quite short), returning OptionScanner#ERROR if not explicitly defined as a LongSpec.

Field Summary

Modifier and Type	Field and Description
pack-priv final boolean	hasArgument
pack-priv final String	key
pack-priv final char	returnValue

Constructor Summary

Access	Constructor and Description
public	LongSpec(String to match key, char to return when that matches returnValue, boolean an argument to the option is expected to follow hasArgument) Define that the long argument should return a given char value in calls to `OptionScanner#getOption()`, and whether or not an option argument should appear following it on the command line.
public	LongSpec(String key, char returnValue) The same as `LongSpec(key, returnValue, false)`.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hasArgument	back to summary
pack-priv final boolean hasArgument

key	back to summary
pack-priv final String key

returnValue	back to summary
pack-priv final char returnValue

Constructor Detail

LongSpec back to summary

LongSpec	back to summary
public LongSpec(String key, char returnValue, boolean hasArgument) Define that the long argument should return a given char value in calls to `OptionScanner#getOption()`, and whether or not an option argument should appear following it on the command line. This character value need not be the same as any single-character option, and may be `OptionScanner#DONE` (typically for the key `"--"`. Parameters key:String to match returnValue:char to return when that matches hasArgument:boolean an argument to the option is expected to follow

public LongSpec(String key, char returnValue, boolean hasArgument)

Define that the long argument should return a given char value in calls to OptionScanner#getOption(), and whether or not an option argument should appear following it on the command line. This character value need not be the same as any single-character option, and may be OptionScanner#DONE (typically for the key "--".

Parameters

key:String: to match
returnValue:char: to return when that matches
hasArgument:boolean: an argument to the option is expected to follow

LongSpec	back to summary
public LongSpec(String key, char returnValue) The same as `LongSpec(key, returnValue, false)`.

pack-priv Class OptionScanner

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class OptionScanner.LongSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail