A B C D E F G H I J L M N O P R S T U V

A

AbstractHandlerDecorator - Class in jcmdline

An abstract class implementing the Decorator design pattern for decoration of CmdLineHandler subclasses.

AbstractHandlerDecorator(CmdLineHandler) - Constructor for class jcmdline.AbstractHandlerDecorator

constructor

AbstractParameter<T> - Class in jcmdline

Base class for command line parameters.

AbstractParameter() - Constructor for class jcmdline.AbstractParameter

acceptableValues - Variable in class jcmdline.AbstractParameter

a set of restricted values the Parameter may take

addArg(Parameter<?>) - Method in class jcmdline.AbstractHandlerDecorator

Adds a command line arguement.

addArg(Parameter<?>) - Method in class jcmdline.BasicCmdLineHandler

Adds a command line arguement.

addArg(Parameter<?>) - Method in interface jcmdline.CmdLineHandler

Adds a command line arguement.

addOption(Parameter<?>) - Method in class jcmdline.AbstractHandlerDecorator

Adds a command line option.

addOption(Parameter<?>) - Method in class jcmdline.BasicCmdLineHandler

Adds a command line option.

addOption(Parameter<?>) - Method in interface jcmdline.CmdLineHandler

Adds a command line option.

addStringValue(String) - Method in class jcmdline.AbstractParameter

Add a value to this Parameter.

addStringValue(String) - Method in interface jcmdline.Parameter

Adds the value, specified as a String.

addValue(T) - Method in class jcmdline.AbstractParameter

addValue(Boolean) - Method in class jcmdline.BooleanParam

Replaces any current value with that specified.

addValue(T) - Method in interface jcmdline.Parameter

Adds the specified Object as a value for this entity - the Object will be validated with respect to the constraints of the Parameter.

attrSpecified(int) - Method in class jcmdline.FileParam

Indicates whether an attribute has been specified for this FileParam.

B

BasicCmdLineHandler - Class in jcmdline

Used to define, parse, and validate the parameters associated with an executable's command line.

BasicCmdLineHandler(String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.BasicCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

BasicCmdLineHandler(String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.BasicCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

BasicCmdLineHandler(String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.BasicCmdLineHandler

constructor

BooleanParam - Class in jcmdline

Encapsulate a boolean command line parameter.

BooleanParam(String, String) - Constructor for class jcmdline.BooleanParam

constructor - creates a public boolean parameter

BooleanParam(String, String, boolean) - Constructor for class jcmdline.BooleanParam

constructor - creates a boolean parameter that is public or hidden, as specified

breakString(String, int) - Method in class jcmdline.StringFormatHelper

Breaks a String along word boundarys to the specified maximum length.

C

CmdLineException - Exception in jcmdline

An Exception that indicates a command line processing error.

CmdLineException(String) - Constructor for exception jcmdline.CmdLineException

constructor

CmdLineException(String, Object[]) - Constructor for exception jcmdline.CmdLineException

constructor

CmdLineHandler - Interface in jcmdline

Interface that describes the API for a command line handler.

CmdLineParser - Interface in jcmdline

Interface desribing the API used between the CmdLineHandler and its command line parser.

convertValue(String) - Method in class jcmdline.AbstractParameter

Converts a String value to the type associated with the Parameter.

convertValue(String) - Method in class jcmdline.BooleanParam

convertValue(String) - Method in class jcmdline.DateParam

convertValue(String) - Method in class jcmdline.DateTimeParam

Converts a String value to its Date equivalent, filling in default seconds and milliseconds as necessary.

convertValue(String) - Method in class jcmdline.FileParam

convertValue(String) - Method in class jcmdline.IntParam

convertValue(String) - Method in class jcmdline.StringParam

convertValue(String) - Method in class jcmdline.TimeParam

D

DateParam - Class in jcmdline

A parameter that accepts a date as its value.

DateParam(String, String) - Constructor for class jcmdline.DateParam

constructor - creates single-valued, optional, public parameter

DateParam(String, String, boolean) - Constructor for class jcmdline.DateParam

constructor - creates single-valued, public parameter which will will be either optional or required, as specified.

DateParam(String, String, boolean, boolean) - Constructor for class jcmdline.DateParam

constructor - creates a public parameter which will will be either optional or required, and/or multi-valued, as specified.

DateParam(String, String, boolean, boolean, boolean) - Constructor for class jcmdline.DateParam

constructor - creates a parameter which will will be either optional or required, single or multi-valued, and hidden or public as specified.

DateParam(String, String, Date[]) - Constructor for class jcmdline.DateParam

constructor - creates a single-valued, optional, public, number parameter whose value must be one of the specified values.

DateParam(String, String, Date[], boolean) - Constructor for class jcmdline.DateParam

constructor - creates a single-valued, public, number parameter whose value must be one of the specified values, and which is required or optional, as specified.

DateParam(String, String, Date[], boolean, boolean) - Constructor for class jcmdline.DateParam

constructor - creates a public number parameter whose value must be one of the specified values, and which is required or optional and/or multi-valued, as specified.

DateParam(String, String, Date[], boolean, boolean, boolean) - Constructor for class jcmdline.DateParam

constructor - creates a Parameter, all of whose options are specified.

DateTimeParam - Class in jcmdline

A parameter that accepts a date and time as its value.

DateTimeParam(String, String) - Constructor for class jcmdline.DateTimeParam

constructor - creates single-valued, optional, public parameter

DateTimeParam(String, String, boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates single-valued, public parameter which will will be either optional or required, as specified.

DateTimeParam(String, String, boolean, boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates a public parameter which will will be either optional or required, and/or multi-valued, as specified.

DateTimeParam(String, String, boolean, boolean, boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates a parameter which will will be either optional or required, single or multi-valued, and hidden or public as specified.

DateTimeParam(String, String, Date[]) - Constructor for class jcmdline.DateTimeParam

constructor - creates a single-valued, optional, public, number parameter whose value must be one of the specified values.

DateTimeParam(String, String, Date[], boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates a single-valued, public, number parameter whose value must be one of the specified values, and which is required or optional, as specified.

DateTimeParam(String, String, Date[], boolean, boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates a public number parameter whose value must be one of the specified values, and which is required or optional and/or multi-valued, as specified.

DateTimeParam(String, String, Date[], boolean, boolean, boolean) - Constructor for class jcmdline.DateTimeParam

constructor - creates a Parameter, all of whose options are specified.

DEFAULT_DIR_OPTION_LABEL - Static variable in class jcmdline.FileParam

the default label that will represent option values for this Parameter where FileParam.IS_DIR is set.

DEFAULT_FILE_OPTION_LABEL - Static variable in class jcmdline.FileParam

the default label that will represent option values for this Parameter where FileParam.IS_DIR is not set.

DEFAULT_OPTION_LABEL - Static variable in class jcmdline.IntParam

the default label that will represent option values for this Parameter when displaying usage.

DEFAULT_OPTION_LABEL - Static variable in class jcmdline.StringParam

the default label that will represent option values for this Parameter when displaying usage.

DefaultCmdLineHandler - Class in jcmdline

A Decorator class that implements command line options for the display of the command's usage.

DefaultCmdLineHandler(CmdLineHandler) - Constructor for class jcmdline.DefaultCmdLineHandler

constructor

DefaultCmdLineHandler(String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.DefaultCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

DefaultCmdLineHandler(String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.DefaultCmdLineHandler

constructor - creates a new BasicCmdLineHandler as its delegate

DefaultCmdLineHandler(String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.DefaultCmdLineHandler

constructor - creates a new BasicCmdLineHandler as its delegate

desc - Variable in class jcmdline.AbstractParameter

a description of the parameter to be displayed in the usage

DOESNT_EXIST - Static variable in class jcmdline.FileParam

indicates that a file or directory specified as a value for this FileParam must not exist

E

EXISTS - Static variable in class jcmdline.FileParam

indicates that a file or directory specified as a value for this FileParam must exist

exitUsageError(String) - Method in class jcmdline.AbstractHandlerDecorator

Prints the usage, followed by the specified error message, to stderr and exits the program with exit status = 1.

exitUsageError(String) - Method in class jcmdline.BasicCmdLineHandler

Prints the usage, followed by the specified error message, to stderr and exits the program with exit status = 1.

exitUsageError(String) - Method in interface jcmdline.CmdLineHandler

Prints the usage, followed by the specified error message, to stderr and exits the program with exit status = 1.

F

FileParam - Class in jcmdline

Encapsulate a command line parameter whose value will be the name of a file or directory.

FileParam(String, String) - Constructor for class jcmdline.FileParam

constructor - creates single-valued, optional, public parameter which accepts any valid file or directory name as its value

FileParam(String, String, boolean) - Constructor for class jcmdline.FileParam

constructor - creates single-valued, public parameter which accepts any valid file or directory name as its value and is optional or required, as specified.

FileParam(String, String, int) - Constructor for class jcmdline.FileParam

constructor - creates a single-valued, optional, public, parameter accepts a file or directory name with the specified attributes.

FileParam(String, String, int, boolean) - Constructor for class jcmdline.FileParam

constructor - creates a single-valued, public, parameter that accepts a file or directory name with the specified attributes, and which is required or optional, as specified.

FileParam(String, String, int, boolean, boolean) - Constructor for class jcmdline.FileParam

constructor - creates a public parameter that accepts a file or directory name with the specified attributes, and which is required or optional and/or multi-valued, as specified.

FileParam(String, String, int, boolean, boolean, boolean) - Constructor for class jcmdline.FileParam

constructor - creates a parameter that accepts a file or directory name with the specified attributes, and which is required or optional and/or multi-valued or hidden, as specified.

formatBlockedText(String, int, int) - Method in class jcmdline.StringFormatHelper

Splits the specified String into lines that are indented by the specified indent and are of length less than or equal to the specified line length.

formatErrorMsg(String) - Method in class jcmdline.TextUsageFormatter

Gets an error message, reformatted in a manner to "go well with" the usage statement.

formatErrorMsg(String) - Method in interface jcmdline.UsageFormatter

Gets an error message, reformatted in a manner to "go well with" the usage statement.

formatHangingIndent(String, int, int) - Method in class jcmdline.StringFormatHelper

Formats a string with a hanging indent.

formatLabeledList(String[], String[], String, int, int) - Method in class jcmdline.StringFormatHelper

Formats a "labeled list" (like a bullet or numbered list, only with labels for each item).

formatText(String, int, int) - Method in class jcmdline.TextUsageFormatter

formatUsage(String, String, Map<String, Parameter<?>>, List<Parameter<?>>, boolean) - Method in class jcmdline.TextUsageFormatter

gets the usage for the command

formatUsage(String, String, Map<String, Parameter<?>>, List<Parameter<?>>, boolean) - Method in interface jcmdline.UsageFormatter

gets the usage for the command

G

get(String) - Static method in class jcmdline.Strings

Gets a String.

get(String, Object[]) - Static method in class jcmdline.Strings

Gets a String, filling in the supplied parameters.

getAcceptableValues() - Method in class jcmdline.AbstractParameter

getAcceptableValues() - Method in interface jcmdline.Parameter

Gets the values that are acceptable for this parameter, if a restricted set exists.

getArg(String) - Method in class jcmdline.AbstractHandlerDecorator

gets the argument specified by tag

getArg(String) - Method in class jcmdline.BasicCmdLineHandler

gets the argument specified by tag

getArg(String) - Method in interface jcmdline.CmdLineHandler

gets the argument specified by tag

getArgs() - Method in class jcmdline.AbstractHandlerDecorator

gets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

getArgs() - Method in class jcmdline.BasicCmdLineHandler

gets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

getArgs() - Method in interface jcmdline.CmdLineHandler

gets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

getAttributes() - Method in class jcmdline.FileParam

gets the value of attributes

getCmdDesc() - Method in class jcmdline.AbstractHandlerDecorator

gets a description of the command's purpose

getCmdDesc() - Method in class jcmdline.BasicCmdLineHandler

gets a description of the command's purpose

getCmdDesc() - Method in interface jcmdline.CmdLineHandler

gets a description of the command's purpose

getCmdName() - Method in class jcmdline.AbstractHandlerDecorator

gets the value of the command name associated with this CmdLineHandler

getCmdName() - Method in class jcmdline.BasicCmdLineHandler

gets the value of the command name associated with this BasicCmdLineHandler

getCmdName() - Method in interface jcmdline.CmdLineHandler

gets the value of the command name associated with this CmdLineHandler

getCustomOptions() - Method in class jcmdline.AbstractHandlerDecorator

Gets options specific to a subclass.

getDatePortion() - Method in class jcmdline.TimeParam

getDefaultMilliSeconds() - Method in class jcmdline.DateTimeParam

Gets the default millisecond value to use if not specified by the user.

getDefaultMilliSeconds() - Method in class jcmdline.TimeParam

Gets the default millisecond value to use if not specified by the user.

getDefaultSeconds() - Method in class jcmdline.DateTimeParam

Gets the seconds default to use if not specified by the user.

getDefaultSeconds() - Method in class jcmdline.TimeParam

Gets the seconds default to use if not specified by the user.

getDefaultTime() - Method in class jcmdline.DateParam

Gets default values for the time component used to generate the Date value.

getDefaultValue() - Method in class jcmdline.BooleanParam

Gets the default value of this Parameter when used as a command line option, and specified just by its tag.

getDefaultValue() - Method in interface jcmdline.OptionTakesNoValue

getDesc() - Method in class jcmdline.AbstractParameter

getDesc() - Method in interface jcmdline.Parameter

gets the value of the parameter's description

getDieOnParseError() - Method in class jcmdline.AbstractHandlerDecorator

Gets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message).

getDieOnParseError() - Method in class jcmdline.BasicCmdLineHandler

Gets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message).

getDieOnParseError() - Method in interface jcmdline.CmdLineHandler

Gets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message).

getHelper() - Static method in class jcmdline.StringFormatHelper

Gets the one and only instance of the StringFormatHelper

getIgnoreRequired() - Method in class jcmdline.AbstractParameter

getIgnoreRequired() - Method in interface jcmdline.Parameter

Gets the flag indicating that during parse, missing required Parameters are ignored if this Parameter is set.

getLineLength() - Method in class jcmdline.TextUsageFormatter

Gets the maximum line length to use for usage display.

getLineLength() - Method in interface jcmdline.UsageFormatter

Gets the maximum line length to use for usage display.

getLogFormatter() - Method in class jcmdline.LoggerCmdLineHandler

Gets the formatter for log messages, defaults to java.util.logging.SimpleFormatter .

getMax() - Method in class jcmdline.IntParam

gets the maximum acceptable value for the parameter

getMaxValLen() - Method in class jcmdline.StringParam

gets the value of the maximum acceptable length for the string value

getMin() - Method in class jcmdline.IntParam

gets minimum acceptable value for the parameter's value

getMinValLen() - Method in class jcmdline.StringParam

gets the value of the minimum acceptable length for the string value

getOption(String) - Method in class jcmdline.AbstractHandlerDecorator

gets the option specified by tag

getOption(String) - Method in class jcmdline.BasicCmdLineHandler

gets the option specified by tag

getOption(String) - Method in interface jcmdline.CmdLineHandler

gets the option specified by tag

getOptionLabel() - Method in class jcmdline.AbstractParameter

getOptionLabel() - Method in interface jcmdline.Parameter

gets the value of optionLabel

getOptions() - Method in class jcmdline.AbstractHandlerDecorator

gets the value of the options associated with the command

getOptions() - Method in class jcmdline.BasicCmdLineHandler

gets the value of the options associated with the command

getOptions() - Method in interface jcmdline.CmdLineHandler

gets the value of the options associated with the command

getParseError() - Method in class jcmdline.AbstractHandlerDecorator

Gets the error message from the last call to parse().

getParseError() - Method in class jcmdline.BasicCmdLineHandler

Gets the error message from the last call to parse().

getParseError() - Method in interface jcmdline.CmdLineHandler

Gets the error message from the last call to parse().

getParseFormat() - Static method in class jcmdline.DateTimeParam

Gets the format used to parse the date/time values.

getParser() - Method in class jcmdline.AbstractHandlerDecorator

Gets the parser to be used to parse the command line.

getParser() - Method in class jcmdline.BasicCmdLineHandler

Gets the parser to be used to parse the command line.

getParser() - Method in interface jcmdline.CmdLineHandler

Gets the parser to be used to parse the command line.

getTag() - Method in class jcmdline.AbstractParameter

getTag() - Method in interface jcmdline.Parameter

gets the value of tag

getUsage(boolean) - Method in class jcmdline.AbstractHandlerDecorator

Gets the usage statement associated with the command.

getUsage(boolean) - Method in class jcmdline.BasicCmdLineHandler

Gets the usage statement associated with the command.

getUsage(boolean) - Method in interface jcmdline.CmdLineHandler

Gets the usage statement associated with the command.

getUsageFormatter() - Method in interface jcmdline.CmdLineParser

Gets a usage formatter suitable for this CmdLineParser's format.

getUsageFormatter() - Method in class jcmdline.PosixCmdLineParser

Gets a usage formatter suitable for this CmdLineParser's format.

getValue() - Method in class jcmdline.AbstractParameter

getValue() - Method in interface jcmdline.Parameter

The value of the parameter, in the case where the parameter is not multi-valued.

getValues() - Method in class jcmdline.AbstractParameter

getValues() - Method in interface jcmdline.Parameter

gets the values associated with this Parameter - the List will be in the order the values were listed on the command line.

H

HelpCmdLineHandler - Class in jcmdline

A CmdLineHandler Decorator class that implements help options that display verbose help messages.

HelpCmdLineHandler(String, CmdLineHandler) - Constructor for class jcmdline.HelpCmdLineHandler

constructor

HelpCmdLineHandler(String, String, CmdLineHandler) - Constructor for class jcmdline.HelpCmdLineHandler

constructor

HelpCmdLineHandler(String, String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

HelpCmdLineHandler(String, String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

HelpCmdLineHandler(String, String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

HelpCmdLineHandler(String, String, String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

HelpCmdLineHandler(String, String, String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

HelpCmdLineHandler(String, String, String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.HelpCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

hidden - Variable in class jcmdline.AbstractParameter

indicates that the parameter is hidden and will not be displayed in the normal usage - default is false

HIDDEN - Static variable in interface jcmdline.Parameter

when used as a value for the hidden indicator, indicates that a parameter is hidden, and its description will not be listed in the usage.

I

ignoreRequired - Variable in class jcmdline.AbstractParameter

During parse, ignore missing required Parameters if this Parameter is set.

IntParam - Class in jcmdline

Encapsulate a command line parameter whose value will be a signed integer in the same range as a java int.

IntParam(String, String) - Constructor for class jcmdline.IntParam

constructor - creates single-valued, optional, public parameter which will accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE.

IntParam(String, String, boolean) - Constructor for class jcmdline.IntParam

constructor - creates single-valued, public parameter which will accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and will be either optional or required, as specified.

IntParam(String, String, boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a public parameter which will accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and will be either optional or required, and/or multi-valued, as specified.

IntParam(String, String, boolean, boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a parameter which will accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and will be either optional or required, and/or multi-valued, as specified.

IntParam(String, String, int, int) - Constructor for class jcmdline.IntParam

constructor - creates a single-valued, optional, public, parameter that will accept an integer between the specifed minimum and maximum values.

IntParam(String, String, int, int, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a single-valued, public parameter that will accept an integer between the specifed minimum and maximum values, and which is required or optional, as specified.

IntParam(String, String, int, int, boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a public parameter that will accept an integer between the specifed minimum and maximum values, and which is required or optional and/or multi-valued, as specified.

IntParam(String, String, int, int, boolean, boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a parameter that will accept an integer between the specifed minimum and maximum values, and for which all other options are specified.

IntParam(String, String, Integer[]) - Constructor for class jcmdline.IntParam

constructor - creates a single-valued, optional, public, number parameter whose value must be one of the specified values.

IntParam(String, String, Integer[], boolean) - Constructor for class jcmdline.IntParam

constructor - creates a single-valued, public, number parameter whose value must be one of the specified values, and which is required or optional, as specified.

IntParam(String, String, Integer[], boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a public number parameter whose value must be one of the specified values, and which is required or optional and/or multi-valued, as specified.

IntParam(String, String, Integer[], boolean, boolean, boolean) - Constructor for class jcmdline.IntParam

constructor - creates a number parameter whose value must be one of the specified values, and all of whose other options are specified.

IS_DIR - Static variable in class jcmdline.FileParam

indicates that a value specified for this FileParam must name an existing directory

IS_FILE - Static variable in class jcmdline.FileParam

indicates that a value specified for this FileParam must name an existing file

IS_READABLE - Static variable in class jcmdline.FileParam

indicates that a value specified for this FileParam must name an existing file or directory for which the caller has read access

IS_WRITEABLE - Static variable in class jcmdline.FileParam

indicates that a value specified for this FileParam must name an existing file or directory for which the caller has write access

isHidden() - Method in class jcmdline.AbstractParameter

isHidden() - Method in interface jcmdline.Parameter

gets the value of the hidden indicator

isMultiValued() - Method in class jcmdline.AbstractParameter

isMultiValued() - Method in interface jcmdline.Parameter

gets the value of multiValued indicator

isOptional() - Method in class jcmdline.AbstractParameter

isOptional() - Method in interface jcmdline.Parameter

returns the value of the optional indicator

isSet() - Method in class jcmdline.AbstractParameter

isSet() - Method in interface jcmdline.Parameter

gets an indicator that the parameter's value has been set

isTrue() - Method in class jcmdline.BooleanParam

Returns the value of the parameter as a boolean.

J

jcmdline - package jcmdline

A package to facilitate the handling of command line options and arguments.

join(String, Object[]) - Static method in class jcmdline.Strings

Join the toString() representations of the specified objects, separating them with the specified separator.

L

LoggerCmdLineHandler - Class in jcmdline

A CmdLineHandler Decorator class that implements a logging option that implements rudimentary support for the java.util.logging package.

LoggerCmdLineHandler(OutputStream, CmdLineHandler) - Constructor for class jcmdline.LoggerCmdLineHandler

constructor

LoggerCmdLineHandler(OutputStream, String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.LoggerCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

LoggerCmdLineHandler(OutputStream, String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.LoggerCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

LoggerCmdLineHandler(OutputStream, String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.LoggerCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

M

max - Variable in class jcmdline.IntParam

the maximum acceptable number - defaults to Integer.MAX_VALUE

maxValLen - Variable in class jcmdline.StringParam

the maximum acceptable string length for the parameter value - if not specified, defaults to StringParam.UNSPECIFIED_LENGTH, which permits the value to be any length.

min - Variable in class jcmdline.IntParam

the minimum acceptable number - defaults to Integer.MIN_VALUE

minValLen - Variable in class jcmdline.StringParam

the minimum acceptable string length for the parameter value - if not specified, defaults to 0.

MULTI_VALUED - Static variable in interface jcmdline.Parameter

when used as a value for the multiValued indicator, specifies that an parameter accepts mulitiple values

multiValued - Variable in class jcmdline.AbstractParameter

Indicates whether the parameter can have multiple values.

N

NO_ATTRIBUTES - Static variable in class jcmdline.FileParam

indicates that no file/dir attributes are required or will be checked

O

optional - Variable in class jcmdline.AbstractParameter

Indicates whether or not the parameter is optional.

OPTIONAL - Static variable in interface jcmdline.Parameter

when used as a value for the optional indicator, specifies that an parameter is optional

optionLabel - Variable in class jcmdline.AbstractParameter

The label that should be used for a Parameter option's value in the usage

OptionTakesNoValue - Interface in jcmdline

An interface indicating an option Paramter that requires no value on the command line (as for the BooleanParam).

P

Parameter<T> - Interface in jcmdline

Interface for command line parameters.

parse(String[]) - Method in class jcmdline.AbstractHandlerDecorator

parse the specified command line arguments

parse(String[]) - Method in class jcmdline.BasicCmdLineHandler

Parse the specified command line arguments.

parse(String[]) - Method in interface jcmdline.CmdLineHandler

parse the specified command line arguments

parse(String[], Map<String, Parameter<?>>, List<Parameter<?>>) - Method in interface jcmdline.CmdLineParser

Parses the passed command line arguments into sets of options and arguments.

parse(String[], Map<String, Parameter<?>>, List<Parameter<?>>) - Method in class jcmdline.PosixCmdLineParser

Parse the specified command line arguments.

PosixCmdLineParser - Class in jcmdline

Used to parse the parameters associated with an executable's command line.

PosixCmdLineParser() - Constructor for class jcmdline.PosixCmdLineParser

constructor

processParsedOptions(boolean) - Method in class jcmdline.AbstractHandlerDecorator

Called from the parse() method after the command line has been parsed.

processParsedOptions(boolean) - Method in class jcmdline.DefaultCmdLineHandler

Called following the call to parse() of this class's contained CmdLineHandler.

processParsedOptions(boolean) - Method in class jcmdline.HelpCmdLineHandler

Called following the call to parse() of this class's contained CmdLineHandler.

processParsedOptions(boolean) - Method in class jcmdline.LoggerCmdLineHandler

Called following the call to parse() of this class's contained CmdLineHandler.

processParsedOptions(boolean) - Method in class jcmdline.VersionCmdLineHandler

Called following the call to parse() of this class's contained CmdLineHandler.

PUBLIC - Static variable in interface jcmdline.Parameter

when used as a value for the hidden indicator, indicates that a parameter is public, and its description will be listed in the usage.

R

REQUIRED - Static variable in interface jcmdline.Parameter

when used as a value for the optional indicator, specifies that an parameter is required

S

set - Variable in class jcmdline.AbstractParameter

indicates that the value of the parameter has been set

setAcceptableValues(Collection<T>) - Method in class jcmdline.AbstractParameter

setAcceptableValues(T[]) - Method in class jcmdline.AbstractParameter

setAcceptableValues(Collection<T>) - Method in interface jcmdline.Parameter

Sets the values that are acceptable for this parameter, if a restricted set exists.

setAcceptableValues(T[]) - Method in interface jcmdline.Parameter

Sets the values that are acceptable for this parameter, if a restricted set exists.

setArgs(Parameter<?>[]) - Method in class jcmdline.AbstractHandlerDecorator

sets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

setArgs(Parameter<?>[]) - Method in class jcmdline.BasicCmdLineHandler

sets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

setArgs(Parameter<?>[]) - Method in interface jcmdline.CmdLineHandler

sets the value of the arguments (what is left on the command line after all options, and their parameters, have been processed) associated with the command

setAttributes(int) - Method in class jcmdline.FileParam

Sets the value of attributes.

setCmdDesc(String) - Method in class jcmdline.AbstractHandlerDecorator

sets a description of the command's purpose

setCmdDesc(String) - Method in class jcmdline.BasicCmdLineHandler

sets a description of the command's purpose

setCmdDesc(String) - Method in interface jcmdline.CmdLineHandler

sets a description of the command's purpose

setCmdName(String) - Method in class jcmdline.AbstractHandlerDecorator

sets the value of the command name associated with this CmdLineHandler

setCmdName(String) - Method in class jcmdline.BasicCmdLineHandler

sets the value of the command name associated with this BasicCmdLineHandler

setCmdName(String) - Method in interface jcmdline.CmdLineHandler

sets the value of the command name associated with this CmdLineHandler

setCustomOptions(Parameter<?>[]) - Method in class jcmdline.AbstractHandlerDecorator

Sets options specific to a subclass.

setDatePortion(Date) - Method in class jcmdline.TimeParam

setDefaultMilliSeconds(int) - Method in class jcmdline.DateTimeParam

Sets the default millisecond value to use if not specified by the user.

setDefaultMilliSeconds(int) - Method in class jcmdline.TimeParam

Sets the default millisecond value to use if not specified by the user.

setDefaultSeconds(int) - Method in class jcmdline.DateTimeParam

Sets the seconds default to use if not specified by the user.

setDefaultSeconds(int) - Method in class jcmdline.TimeParam

Sets the seconds default to use if not specified by the user.

setDefaultTime(int, int, int, int) - Method in class jcmdline.DateParam

Sets default values for the time component used to generate the Date value.

setDesc(String) - Method in class jcmdline.AbstractParameter

setDesc(String) - Method in interface jcmdline.Parameter

sets the value of this parameter's description

setDieOnParseError(boolean) - Method in class jcmdline.AbstractHandlerDecorator

Sets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message).

setDieOnParseError(boolean) - Method in class jcmdline.BasicCmdLineHandler

Sets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message) - defaults to true.

setDieOnParseError(boolean) - Method in interface jcmdline.CmdLineHandler

Sets a flag indicating that the program should exit in the case of a parse error (after displaying the usage and an error message) - defaults to true.

setHidden(boolean) - Method in class jcmdline.AbstractParameter

setHidden(boolean) - Method in interface jcmdline.Parameter

sets the value of the hidden indicator

setIgnoreRequired(boolean) - Method in class jcmdline.AbstractParameter

setIgnoreRequired(boolean) - Method in interface jcmdline.Parameter

Sets a flag such that during parse, missing required Parameters are ignored if this Parameter is set.

setLineLength(int) - Method in class jcmdline.TextUsageFormatter

Sets the maximum line length to use for usage display - default is 80.

setLineLength(int) - Method in interface jcmdline.UsageFormatter

Sets the maximum line length to use for usage display.

setLogFormatter(Formatter) - Method in class jcmdline.LoggerCmdLineHandler

Sets the formatter for log messages, defaults to java.util.logging.SimpleFormatter .

setMax(int) - Method in class jcmdline.IntParam

Sets the maximum acceptable value for the parameter.

setMaxLength(int) - Method in class jcmdline.StringParam

Deprecated. This method deprecated in favor of setMaxValLen(), which is more in line with the naming convetions used elsewhere in this class.

setMaxValLen(int) - Method in class jcmdline.StringParam

sets the value of the maximum acceptable length for the string value

setMin(int) - Method in class jcmdline.IntParam

Sets the minimum acceptable value for the parameter's value.

setMinValLen(int) - Method in class jcmdline.StringParam

sets the value of the minimum acceptable length for the string value

setMultiValued(boolean) - Method in class jcmdline.AbstractParameter

setMultiValued(boolean) - Method in interface jcmdline.Parameter

sets the value of the multiValued indicator

setOptional(boolean) - Method in class jcmdline.AbstractParameter

setOptional(boolean) - Method in interface jcmdline.Parameter

indicates whether or not the parameter is optional

setOptionLabel(String) - Method in class jcmdline.AbstractParameter

setOptionLabel(String) - Method in interface jcmdline.Parameter

Sets the value of optionLabel.

setOptions(Parameter<?>[]) - Method in class jcmdline.AbstractHandlerDecorator

Sets the value of the options associated with the command

setOptions(Parameter<?>[]) - Method in class jcmdline.BasicCmdLineHandler

Sets the value of the options associated with the command

setOptions(Parameter<?>[]) - Method in interface jcmdline.CmdLineHandler

Sets the value of the options associated with the command

setParseError(String) - Method in class jcmdline.AbstractHandlerDecorator

Sets the error message from the last call to parse().

setParseError(String) - Method in class jcmdline.BasicCmdLineHandler

Sets the error message from the last call to parse().

setParseError(String) - Method in interface jcmdline.CmdLineHandler

Sets the error message from the last call to parse().

setParser(CmdLineParser) - Method in class jcmdline.AbstractHandlerDecorator

Sets the parser to be used to parse the command line.

setParser(CmdLineParser) - Method in class jcmdline.BasicCmdLineHandler

Sets the parser to be used to parse the command line.

setParser(CmdLineParser) - Method in interface jcmdline.CmdLineHandler

Sets the parser to be used to parse the command line.

setTag(String) - Method in class jcmdline.AbstractParameter

setTag(String) - Method in interface jcmdline.Parameter

sets the value of tag

setUsageFormatter(UsageFormatter) - Method in interface jcmdline.CmdLineParser

Sets a usage formatter suitable for this CmdLineParser's format.

setUsageFormatter(UsageFormatter) - Method in class jcmdline.PosixCmdLineParser

Sets a usage formatter suitable for this CmdLineParser's format.

setValue(T) - Method in class jcmdline.AbstractParameter

setValue(T) - Method in interface jcmdline.Parameter

Sets the value of the parameter to the specified string.

setValues(List<T>) - Method in class jcmdline.AbstractParameter

setValues(T[]) - Method in class jcmdline.AbstractParameter

setValues(List<T>) - Method in interface jcmdline.Parameter

Sets the values of the parameter to those specified.

setValues(T[]) - Method in interface jcmdline.Parameter

Sets the values of the parameter to those specified.

SINGLE_VALUED - Static variable in interface jcmdline.Parameter

when used as a value for the multiValued indicator, specifies that a parameter accepts only one value

StringFormatHelper - Class in jcmdline

A class used to facilitate common String formatting tasks.

StringParam - Class in jcmdline

Encapsulate a command line parameter whose value will be a string.

StringParam(String, String) - Constructor for class jcmdline.StringParam

constructor - creates single-valued, optional, parameter accepting a string value of any length

StringParam(String, String, boolean) - Constructor for class jcmdline.StringParam

constructor - creates single-valued, parameter accepting a string value of any length, and either optional or required, as specified.

StringParam(String, String, int, int) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, optional, parameter accepting a value whose length is within the specified minimum and maximum lengths.

StringParam(String, String, int, int, boolean) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, parameter accepting a value whose length is within the specified minimum and maximum lengths, and is optional or required, as specified.

StringParam(String, String, int, int, boolean, boolean) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, parameter accepting a value whose length is within the specified minimum and maximum lengths, and optional and/or multi-valued, as specified

StringParam(String, String, int, int, boolean, boolean, boolean) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, parameter accepting a value whose length is within the specified minimum and maximum lengths, with all other options specified.

StringParam(String, String, String[]) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, optional, string parameter whose value must be one of the specified values.

StringParam(String, String, String[], boolean) - Constructor for class jcmdline.StringParam

constructor - creates a single-valued, string parameter whose value must be a specified value, and which is optional or required, as specified.

StringParam(String, String, String[], boolean, boolean) - Constructor for class jcmdline.StringParam

constructor - creates a string parameter whose value must be a specified value and is optional and/or * multi-valued, as specified.

StringParam(String, String, String[], boolean, boolean, boolean) - Constructor for class jcmdline.StringParam

constructor - creates a string parameter whose value must be a specified value and all other options are as specified.

Strings - Class in jcmdline

A helper class used to obtain Strings for this package.

Strings() - Constructor for class jcmdline.Strings

T

tag - Variable in class jcmdline.AbstractParameter

the tag which uniquely identifies the parameter, and will be used to identify the parameter on the command line if the parameter is used as an option

TextUsageFormatter - Class in jcmdline

Used to format a command's usage.

TextUsageFormatter() - Constructor for class jcmdline.TextUsageFormatter

constructor

TimeParam - Class in jcmdline

A parameter that accepts a time as its value.

TimeParam(String, String) - Constructor for class jcmdline.TimeParam

constructor - creates single-valued, optional, public parameter, with a default datePortion of the current day

TimeParam(String, String, boolean) - Constructor for class jcmdline.TimeParam

constructor - creates single-valued, public parameter which will will be either optional or required, as specified, with a default datePortion of the current day

TimeParam(String, String, boolean, boolean) - Constructor for class jcmdline.TimeParam

constructor - creates a public parameter which will will be either optional or required, and/or multi-valued, as specified, with a default datePortion of the current day

TimeParam(String, String, boolean, boolean, boolean) - Constructor for class jcmdline.TimeParam

constructor - creates a parameter which will will be either optional or required, single or multi-valued, and hidden or public as specified, with a default datePortion of the current day

TimeParam(String, String, Date[]) - Constructor for class jcmdline.TimeParam

constructor - creates a single-valued, optional, public, number parameter whose value must be one of the specified values, with a default datePortion of the current day

TimeParam(String, String, Date[], boolean) - Constructor for class jcmdline.TimeParam

constructor - creates a single-valued, public, number parameter whose value must be one of the specified values, and which is required or optional, as specified, with a default datePortion of the current day

TimeParam(String, String, Date[], boolean, boolean) - Constructor for class jcmdline.TimeParam

constructor - creates a public number parameter whose value must be one of the specified values, and which is required or optional and/or multi-valued, as specified, with a default datePortion of the current day

TimeParam(String, String, Date[], boolean, boolean, boolean) - Constructor for class jcmdline.TimeParam

constructor - creates a Parameter, all of whose options are specified, with a default datePortion of the current day

U

UNSPECIFIED_LENGTH - Static variable in class jcmdline.StringParam

the value of the minimum or maximum length if they have not been explicitly specified.

UsageFormatter - Interface in jcmdline

Used to format a command's usage.

V

validateValue(T) - Method in class jcmdline.AbstractParameter

This implementation compares the value to the acceptable values if any have been defined.

validateValue(File) - Method in class jcmdline.FileParam

Validates a prospective value for the FileParam - called by add/setValue(s)().

validateValue(Integer) - Method in class jcmdline.IntParam

Validates a prospective value with regards to the minimum and maximum values and the acceptableValues called by add/setValue(s)().

validateValue(String) - Method in class jcmdline.StringParam

Validates a prospective value with regards to the minimum and maximum values and the acceptableValues - called by add/setValue(s)().

validateValue(Date) - Method in class jcmdline.TimeParam

values - Variable in class jcmdline.AbstractParameter

the value(s) of the entity

VersionCmdLineHandler - Class in jcmdline

A CmdLineHandler Decorator class that implements a -version option.

VersionCmdLineHandler(String, CmdLineHandler) - Constructor for class jcmdline.VersionCmdLineHandler

constructor

VersionCmdLineHandler(String, String, String, Collection<Parameter<?>>, Collection<Parameter<?>>) - Constructor for class jcmdline.VersionCmdLineHandler

constructor - uses the PosixCmdLineParser to parse the command line

VersionCmdLineHandler(String, String, String, Parameter<?>[], Parameter<?>[]) - Constructor for class jcmdline.VersionCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

VersionCmdLineHandler(String, String, String, Parameter<?>[], Parameter<?>[], CmdLineParser) - Constructor for class jcmdline.VersionCmdLineHandler

constructor - creates a new DefaultCmdLineHandler as its delegate

A B C D E F G H I J L M N O P R S T U V