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

A

AbstractParameter - class com.martiansoftware.jsap.AbstractParameter.
Top-level abstraction of a parameter.
AbstractParameter(String) - Constructor for class com.martiansoftware.jsap.AbstractParameter
Creates a new AbstractParameter.
addConfiguredDefault(DefaultValue) - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Adds a configured default value to the current list of default values for this parameter.
addConfiguredFlaggedoption(FlaggedOptionConfiguration) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Adds a nested FlaggedOptionConfiguration to the generated JSAP.
addConfiguredProperty(ParserProperty) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Adds a property to the current list of properties for this option's PropertyStringParser.
addConfiguredSwitch(SwitchConfiguration) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Adds a nested SwitchConfiguration to the generated JSAP.
addConfiguredUnflaggedoption(UnflaggedOptionConfiguration) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Adds a nested UnflaggedOptionConfiguration to the generated JSAP.
addDefault(String) - Method in class com.martiansoftware.jsap.AbstractParameter
Adds a single default value to any currently defined for this parameter.
addDefault(String, String) - Method in class com.martiansoftware.jsap.Defaults
Adds a single default value to any that might already be defined for the parameter with the the specified ID.
addDefault(String, String[]) - Method in class com.martiansoftware.jsap.Defaults
Adds an array of default values to any that might already be defined for the parameter with the the specified ID.
addException(String, Exception) - Method in interface com.martiansoftware.jsap.ExceptionMap
Adds the specified exception to the exception map.
addException(String, Exception) - Method in class com.martiansoftware.jsap.JSAPResult
Adds the specified exception to the exception map.
addText(String) - Method in class com.martiansoftware.jsap.ant.DefaultValue
Sets the default value.
allowMultipleDeclarations() - Method in class com.martiansoftware.jsap.FlaggedOption
Returns a boolean indicating whether multiple declarations are allowed for this FlaggedOption.

B

BigDecimalStringParser - class com.martiansoftware.jsap.stringparsers.BigDecimalStringParser.
A StringParser for parsing BigDecimals.
BigDecimalStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BigDecimalStringParser
Creates a new BigDecimalStringParser.
BigIntegerStringParser - class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser.
A StringParser for parsing BigIntegers.
BigIntegerStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser
Creates a new BigIntegerStringParser.
BooleanStringParser - class com.martiansoftware.jsap.stringparsers.BooleanStringParser.
A StringParser for parsing Booleans.
BooleanStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BooleanStringParser
Creates a new BooleanStringParser
ByteStringParser - class com.martiansoftware.jsap.stringparsers.ByteStringParser.
A StringParser for parsing Bytes.
ByteStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ByteStringParser
Creates a new ByteStringParser.

C

CONSTRUCTOR_VALUE_SEPARATOR - Static variable in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
char used to separate enumerated values when they are supplied to the constructor
CharacterStringParser - class com.martiansoftware.jsap.stringparsers.CharacterStringParser.
A StringParser for parsing Characters.
CharacterStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.CharacterStringParser
Creates a new CharacterStringParser.
ClassStringParser - class com.martiansoftware.jsap.stringparsers.ClassStringParser.
A StringParser for parsing Class objects.
ClassStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ClassStringParser
Creates a new ClassStringParser.
ColorStringParser - class com.martiansoftware.jsap.stringparsers.ColorStringParser.
A StringParser for parsing java.awt.Color objects.
ColorStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ColorStringParser
Creates a new ColorStringParser.
CommandLineTokenizer - class com.martiansoftware.jsap.CommandLineTokenizer.
A utility class to parse a command line contained in a single String into an array of argument tokens, much as the JVM (or more accurately, your operating system) does before calling your programs' public static void main(String[] args) methods.
com.martiansoftware.jsap - package com.martiansoftware.jsap
 
com.martiansoftware.jsap.ant - package com.martiansoftware.jsap.ant
 
com.martiansoftware.jsap.defaultsources - package com.martiansoftware.jsap.defaultsources
 
com.martiansoftware.jsap.examples - package com.martiansoftware.jsap.examples
 
com.martiansoftware.jsap.stringparsers - package com.martiansoftware.jsap.stringparsers
 
com.martiansoftware.util - package com.martiansoftware.util
 
createMethod(String, PrintStream) - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Creates source code for a java method that will instantiate a FlaggedOption matching this configuration.
createMethod(String, PrintStream) - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Creates source code for a java method that creates a parameter matching this object's configuration.
createMethod(String, PrintStream) - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Creates java source code for a method that will instantiate and configure a Switch according to this configuration.
createMethod(String, PrintStream) - Method in class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
Creates java source code for a method that instantiates an UnflaggedOption and configures it according to this configuration.

D

DEFAULT_LISTSEPARATOR - Static variable in class com.martiansoftware.jsap.JSAP
The default separator for list parameters (equivalent to java.io.File.pathSeparatorChar)
DateStringParser - class com.martiansoftware.jsap.stringparsers.DateStringParser.
A StringParser for parsing java.util.Date objects.
DateStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.DateStringParser
Creates a new DateStringParser.
DefaultSource - interface com.martiansoftware.jsap.DefaultSource.
An interface describing an object as being able to produce a set of default values.
DefaultValue - class com.martiansoftware.jsap.ant.DefaultValue.
Provides a means of specifying default values for the jsap task containing <default> elements.
DefaultValue() - Constructor for class com.martiansoftware.jsap.ant.DefaultValue
 
Defaults - class com.martiansoftware.jsap.Defaults.
Stores a collection of default values, associated with their respective parameters by the parameters' unique IDs.
Defaults() - Constructor for class com.martiansoftware.jsap.Defaults
Creates a new, empty Defaults object.
DoubleStringParser - class com.martiansoftware.jsap.stringparsers.DoubleStringParser.
A StringParser for parsing Doubles.
DoubleStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.DoubleStringParser
Creates a new DoubleStringParser.
declaredListSeparator() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns a boolean indicating whether the list separator character has been specified by the user.

E

EnumeratedStringParser - class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser.
A StringParser that enforces a limited set of String options for its values.
These values are provided in the constructor together with one or two parameters
that control the processing of these values.
EnumeratedStringParser(String, boolean, boolean) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
Constructs a new instance of EnumeratedParameterParser.
EnumeratedStringParser(String, boolean) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
Constructs a new instance of EnumeratedStringParser with parameter "checkOptionChars" set to true.
EnumeratedStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
Constructs a new instance of EnumeratedStringParser with parameter
"caseSensitive" set to false
and "checkOptionChars" set to true.
All command line arguments for this parser and the values provided
by the user in this constructor are converted to lower case.
Example1 - class com.martiansoftware.jsap.examples.Example1.
 
Example1() - Constructor for class com.martiansoftware.jsap.examples.Example1
 
ExceptionMap - interface com.martiansoftware.jsap.ExceptionMap.
A class for aggregating exceptions thrown by JSAP's parsing process.
execute() - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Validates the JSAP configuration and, if successful, writes the java source code for a JSAP subclass that implements the configuration specified in the ant build file.

F

Flagged - interface com.martiansoftware.jsap.Flagged.
Marks an argument as being "flagged" - that is, as having its value on the command line preceded by an indicator.
FlaggedOption - class com.martiansoftware.jsap.FlaggedOption.
An option that implements the Flagged interface.
FlaggedOption(String) - Constructor for class com.martiansoftware.jsap.FlaggedOption
Creates a new FlaggedOption with the specified unique ID.
FlaggedOption(String, StringParser, String, boolean, char, String) - Constructor for class com.martiansoftware.jsap.FlaggedOption
A shortcut constructor that creates a new FlaggedOption and configures its most commonly used settings.
FlaggedOptionConfiguration - class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration.
Stores/provides configuration data for flaggedoptions nested inside a jsap ant task.
FlaggedOptionConfiguration() - Constructor for class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Creates a new FlaggedOptionConfiguration.
FloatStringParser - class com.martiansoftware.jsap.stringparsers.FloatStringParser.
A StringParser for parsing Floats.
FloatStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.FloatStringParser
Creates a new FloatStringParser.
finalize() - Method in class com.martiansoftware.jsap.JSAP
Unregisters all registered AbstractParameters, allowing them to perform their cleanup.

G

GREEDY - Static variable in class com.martiansoftware.jsap.JSAP
The parameter consumes the command line.
getBadParameterIDIterator() - Method in class com.martiansoftware.jsap.JSAPResult
Returns an Iterator over the IDs of all parameters with associated exceptions (which can in turn be obtained via getExceptionIterator(String)).
getBigDecimal(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first BigDecimal value associated with the specified id.
getBigDecimal(String, BigDecimal) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first BigDecimal value associated with the specified id.
getBigDecimalArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of BigDecimal values associated with the specified id.
getBigInteger(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first BigInteger value associated with the specified id.
getBigInteger(String, BigInteger) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first BigInteger value associated with the specified id.
getBigIntegerArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of BigInteger values associated with the specified id.
getBoolean(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first boolean value associated with the specified id.
getBoolean(String, boolean) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first boolean value associated with the specified id.
getBooleanArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of boolean values associated with the specified id.
getByID(String) - Method in class com.martiansoftware.jsap.JSAP
Returns the requested Switch, FlaggedOption, or UnflaggedOption with the specified ID.
getByLongFlag(String) - Method in class com.martiansoftware.jsap.JSAP
Returns the requested Switch or FlaggedOption with the specified long flag.
getByShortFlag(Character) - Method in class com.martiansoftware.jsap.JSAP
Returns the requested Switch or FlaggedOption with the specified short flag.
getByShortFlag(char) - Method in class com.martiansoftware.jsap.JSAP
Returns the requested Switch or FlaggedOption with the specified short flag.
getByte(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first byte value associated with the specified id.
getByte(String, byte) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first byte value associated with the specified id.
getByteArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of byte values associated with the specified id.
getChar(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first char value associated with the specified id.
getChar(String, char) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first char value associated with the specified id.
getCharArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of char values associated with the specified id.
getClass(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Class value associated with the specified id.
getClass(String, Class) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Class value associated with the specified id.
getClassArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of Class values associated with the specified id.
getColor(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Color value associated with the specified id.
getColor(String, Color) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Color value associated with the specified id.
getColorArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of Color values associated with the specified id.
getDate(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Date value associated with the specified id.
getDate(String, Date) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Date value associated with the specified id.
getDateArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of Date values associated with the specified id.
getDefault() - Method in class com.martiansoftware.jsap.AbstractParameter
Returns an array of default values for this parameter, or null if no default values have been defined.
getDefault(String) - Method in class com.martiansoftware.jsap.Defaults
Returns an array of the default values defined for the parameter with the specified ID, or null if no default values are defined.
getDefaults(IDMap, ExceptionMap) - Method in interface com.martiansoftware.jsap.DefaultSource
Returns a set of default values given the configuration described by the specified IDMap.
getDefaults() - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Returns an array of this parameter's default values, or a zero-length array if none exist.
getDefaults(IDMap, ExceptionMap) - Method in class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource
Returns a Defaults object based upon this PropertyDefaultSource's properties and the specified IDMap.
getDouble(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first double value associated with the specified id.
getDouble(String, double) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first double value associated with the specified id.
getDoubleArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of double values associated with the specified id.
getErrorMessageIterator() - Method in class com.martiansoftware.jsap.JSAPResult
Returns an iterator over all error messages generated during parsing.
getException(String) - Method in interface com.martiansoftware.jsap.ExceptionMap
Returns the first exception associated with the specified parameter ID.
getException(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first exception associated with the specified parameter ID.
getExceptionArray(String) - Method in interface com.martiansoftware.jsap.ExceptionMap
Returns an array of ALL exceptions associated with the specified parameter ID.
getExceptionArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of ALL exceptions associated with the specified parameter ID.
getExceptionIterator(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an Iterator ovar ALL exceptions associated with the specified parameter ID.
getFlag() - Method in class com.martiansoftware.jsap.UnknownFlagException
Returns the unknown flag that was encountered.
getFloat(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first float value associated with the specified id.
getFloat(String, float) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first float value associated with the specified id.
getFloatArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of float values associated with the specified id.
getGreedy() - Method in class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
Returns a boolean indicating whether this UnflaggedOption is greedy.
getHelp() - Method in class com.martiansoftware.jsap.AbstractParameter
Returns a description of the option's usage.
getHelp() - Method in class com.martiansoftware.jsap.JSAP
A shortcut method for calling getHelp(80).
getHelp(int) - Method in class com.martiansoftware.jsap.JSAP
If the help text has been manually set, this method simply returns it, ignoring the screenWidth parameter.
getID() - Method in class com.martiansoftware.jsap.AbstractParameter
Returns this parameter's unique ID.
getID() - Method in class com.martiansoftware.jsap.IllegalMultipleDeclarationException
Returns the unique ID of the parameter that was illegally declared more than once.
getID() - Method in class com.martiansoftware.jsap.RequiredParameterMissingException
Returns the unique ID of the parameter that was missing.
getIDByLongFlag(String) - Method in class com.martiansoftware.jsap.IDMap
Returns the unique ID of the parameter with the specified long flag, or null if the specified long flag is not defined in this IDMap.
getIDByShortFlag(Character) - Method in class com.martiansoftware.jsap.IDMap
Returns the unique ID of the parameter with the specified short flag, or null if the specified short flag is not defined in this IDMap.
getIDByShortFlag(char) - Method in class com.martiansoftware.jsap.IDMap
Returns the unique ID of the parameter with the specified short flag, or null if the specified short flag is not defined in this IDMap.
getIDMap() - Method in class com.martiansoftware.jsap.JSAP
Returns an IDMap associating long and short flags with their associated parameters' IDs, and allowing the listing of IDs.
getId() - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Returns the unique ID for this parameter.
getInetAddress(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first InetAddress value associated with the specified id.
getInetAddress(String, InetAddress) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first InetAddress value associated with the specified id.
getInetAddressArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of InetAddress values associated with the specified id.
getInt(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first integer value associated with the specified id.
getInt(String, int) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first integer value associated with the specified id.
getIntArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of integer values associated with the specified id.
getIslist() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns a boolean indicating whether this option is a list.
getListSeparator() - Method in class com.martiansoftware.jsap.Option
Returns the current list separator character for this Option.
getListseparator() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns the list separator character for this option.
getLong(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first long value associated with the specified id.
getLong(String, long) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first long value associated with the specified id.
getLongArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of long values associated with the specified id.
getLongFlag() - Method in interface com.martiansoftware.jsap.Flagged
Returns the long flag for this object.
getLongFlag() - Method in class com.martiansoftware.jsap.FlaggedOption
Returns the long flag for this FlaggedOption.
getLongFlag() - Method in class com.martiansoftware.jsap.Switch
Returns the long flag for this Switch.
getLongflag() - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Returns the long flag for this option.
getLongflag() - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Returns the long flag for this switch.
getName() - Method in class com.martiansoftware.jsap.ant.ParserProperty
Returns the name of this property.
getObject(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first object associated with the specified ID.
getObjectArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns all values associated with the specified ID.
getObjectArray(String, Object[]) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array containing all of the values associated with the specified ID.
getPackage(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Package value associated with the specified id.
getPackage(String, Package) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first Package value associated with the specified id.
getPackageArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of Package values associated with the specified id.
getParameter() - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Returns a FlaggedOption preconfigured according to this configuration.
getParameter() - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Returns an AbstractParameter (String, FlaggedOption, or UnflaggedOption) configured according to the settings contained within this object.
getParameter() - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Returns a Switch configured according to this configuration.
getParameter() - Method in class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
Returns an UnflaggedOption configured according to this configuration.
getParserProperties() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns an array of ParserProperties for this option's PropertyStringParser, or null if no ParserProperties are defined.
getProperty(String) - Method in class com.martiansoftware.jsap.PropertyStringParser
Returns the property associated with the specified key, or null if no such property exists.
getProperty(String, String) - Method in class com.martiansoftware.jsap.PropertyStringParser
Returns the property associated with the specified key, or the specified default value if no such property exists.
getQualifiedSwitchValue(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the string value associated with the specified ID for QualifiedSwitches.
getRequired() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns a boolean indicating whether this option is required.
getShort(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first short value associated with the specified id.
getShort(String, short) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first short value associated with the specified id.
getShortArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of short values associated with the specified id.
getShortFlag() - Method in interface com.martiansoftware.jsap.Flagged
Returns the short flag for this object in the form of a char.
getShortFlag() - Method in class com.martiansoftware.jsap.FlaggedOption
Returns the short flag for this FlaggedOption.
getShortFlag() - Method in class com.martiansoftware.jsap.Switch
Returns the short flag for this Switch.
getShortFlagCharacter() - Method in interface com.martiansoftware.jsap.Flagged
Returns the short flag for this object in the form of a Character.
getShortFlagCharacter() - Method in class com.martiansoftware.jsap.FlaggedOption
Returns the short flag for this FlaggedOption.
getShortFlagCharacter() - Method in class com.martiansoftware.jsap.Switch
Returns the short flag for this Switch.
getShortflag() - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Returns the short flag for this option.
getShortflag() - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Returns the short flag for this switch.
getString(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first String value associated with the specified id.
getString(String, String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first String value associated with the specified id.
getStringArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of String values associated with the specified id.
getStringParser() - Method in class com.martiansoftware.jsap.Option
Returns the StringParser to which this Option will delegate calls to its parse() method, or null if no StringParser is currently defined.
getStringparser() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns the classname of the StringParser for this option.
getSyntax() - Method in class com.martiansoftware.jsap.AbstractParameter
A convenience method for automatically generating syntax information based upon a JSAP configuration.
getSyntax() - Method in class com.martiansoftware.jsap.FlaggedOption
Returns syntax instructions for this FlaggedOption.
getSyntax() - Method in class com.martiansoftware.jsap.QualifiedSwitch
Returns syntax instructions for this QualifiedSwitch.
getSyntax() - Method in class com.martiansoftware.jsap.Switch
Returns usage instructions for this Switch.
getSyntax() - Method in class com.martiansoftware.jsap.UnflaggedOption
Returns syntax instructions for this FlaggedOption.
getURL(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first URL value associated with the specified id.
getURL(String, URL) - Method in class com.martiansoftware.jsap.JSAPResult
Returns the first URL value associated with the specified id.
getURLArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
Returns an array of URL values associated with the specified id.
getUnflaggedOptionsIterator() - Method in class com.martiansoftware.jsap.JSAP
Returns an Iterator over all UnflaggedOptions currently registered with this JSAP.
getUsage() - Method in class com.martiansoftware.jsap.AbstractParameter
Deprecated. use getSyntax() instead
getUsage() - Method in class com.martiansoftware.jsap.JSAP
Returns an automatically generated usage description based upon this JSAP's current configuration.
getValue() - Method in class com.martiansoftware.jsap.ant.DefaultValue
Returns the default value.
getValue() - Method in class com.martiansoftware.jsap.ant.ParserProperty
Returns the value of this property.

H

hasProperties() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Returns a boolean indicating whether any ParserProperties are defined.
hasProperties() - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Returns a boolean indicating whether this parameter has any properties associated with its StringParser.

I

IDMap - class com.martiansoftware.jsap.IDMap.
A utility class to allow lookups of parameter IDs by short flag or long flag.
IDMap(List, Map, Map) - Constructor for class com.martiansoftware.jsap.IDMap
Creates a new IDMap.
IllegalMultipleDeclarationException - exception com.martiansoftware.jsap.IllegalMultipleDeclarationException.
An exception indicating that a parameter has illegally been declared multiple times.
IllegalMultipleDeclarationException(String) - Constructor for class com.martiansoftware.jsap.IllegalMultipleDeclarationException
Creates a new IllegalMultipleDeclarationException referencing the specified parameter.
InetAddressStringParser - class com.martiansoftware.jsap.stringparsers.InetAddressStringParser.
A StringParser for parsing java.net.InetAddress objects.
InetAddressStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.InetAddressStringParser
Creates a new InetAddressStringParser.
IntegerStringParser - class com.martiansoftware.jsap.stringparsers.IntegerStringParser.
A StringParser for parsing Integers.
IntegerStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.IntegerStringParser
Creates a new IntegerStringParser.
idExists(String) - Method in class com.martiansoftware.jsap.IDMap
Returns true if the specified ID is stored in this IDMap, false if not.
idIterator() - Method in class com.martiansoftware.jsap.Defaults
Returns an Iterator over the unique IDs of all parameters with defaults defined in this Defaults object.
idIterator() - Method in class com.martiansoftware.jsap.IDMap
Returns an Iterator over all parameter IDs stored in this IDMap.
isGreedy() - Method in class com.martiansoftware.jsap.UnflaggedOption
Returns a boolean indicating whether this UnflaggedOption is greedy.
isList() - Method in class com.martiansoftware.jsap.Option
Returns a boolean indicating whether this Option is a list.

J

JSAP - class com.martiansoftware.jsap.JSAP.
The core class of the JSAP (Java Simple Argument Parser) API.
JSAP() - Constructor for class com.martiansoftware.jsap.JSAP
Creates a new JSAP with an empty configuration.
JSAPAntTask - class com.martiansoftware.jsap.ant.JSAPAntTask.
An ANT task that generates a custom subclass of JSAP to simplify its use in a program.
JSAPAntTask() - Constructor for class com.martiansoftware.jsap.ant.JSAPAntTask
Creates a new JSAPAntTask.
JSAPException - exception com.martiansoftware.jsap.JSAPException.
The base class for all of JSAP's exceptions.
JSAPException() - Constructor for class com.martiansoftware.jsap.JSAPException
Creates a new JSAPException.
JSAPException(String) - Constructor for class com.martiansoftware.jsap.JSAPException
Creates a new JSAPException with the specified message.
JSAPException(Throwable) - Constructor for class com.martiansoftware.jsap.JSAPException
Creates a new JSAPException encapsulating the specified Throwable.
JSAPException(String, Throwable) - Constructor for class com.martiansoftware.jsap.JSAPException
Creates a new JSAPException with the specified message encapsulating the specified Throwable.
JSAPResult - class com.martiansoftware.jsap.JSAPResult.
Encapsulates the results of JSAP's parse() methods.

L

LIST - Static variable in class com.martiansoftware.jsap.JSAP
The parameter is a list.
LongStringParser - class com.martiansoftware.jsap.stringparsers.LongStringParser.
A StringParser for parsing Longs.
LongStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.LongStringParser
Creates a new LongStringParser.

M

MULTIPLEDECLARATIONS - Static variable in class com.martiansoftware.jsap.JSAP
The parameter allows multiple declarations.
Manual_HelloWorld_1 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_1.
 
Manual_HelloWorld_1() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_1
 
Manual_HelloWorld_2 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_2.
 
Manual_HelloWorld_2() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_2
 
Manual_HelloWorld_3 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_3.
 
Manual_HelloWorld_3() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_3
 
Manual_HelloWorld_4 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_4.
 
Manual_HelloWorld_4() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_4
 
Manual_HelloWorld_5 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_5.
 
Manual_HelloWorld_5() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_5
 
Manual_HelloWorld_6 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_6.
 
Manual_HelloWorld_6() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_6
 
Manual_HelloWorld_7 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_7.
 
Manual_HelloWorld_7() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_7
 
Manual_HelloWorld_8 - class com.martiansoftware.jsap.examples.Manual_HelloWorld_8.
 
Manual_HelloWorld_8() - Constructor for class com.martiansoftware.jsap.examples.Manual_HelloWorld_8
 
main(String[]) - Static method in class com.martiansoftware.jsap.TestCommandLineTokenizer
A helper method to write additional test cases based upon the specified argument array.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Example1
 
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_1
 
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_2
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_3
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_4
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_5
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_6
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_7
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.jsap.examples.Manual_HelloWorld_8
Repeats the "Hello World" text multiple times.
main(String[]) - Static method in class com.martiansoftware.util.StringUtils
 

N

NOT_GREEDY - Static variable in class com.martiansoftware.jsap.JSAP
The parameter does not consume the command line.
NOT_LIST - Static variable in class com.martiansoftware.jsap.JSAP
The parameter is not a list.
NOT_REQUIRED - Static variable in class com.martiansoftware.jsap.JSAP
The parameter is not required.
NO_DEFAULT - Static variable in class com.martiansoftware.jsap.JSAP
The parameter has no default value.
NO_LONGFLAG - Static variable in class com.martiansoftware.jsap.JSAP
Does not have a long flag.
NO_MULTIPLEDECLARATIONS - Static variable in class com.martiansoftware.jsap.JSAP
The parameter does not allow multiple declarations.
NO_SHORTFLAG - Static variable in class com.martiansoftware.jsap.JSAP
Does not have a short flag.
noNull(String) - Static method in class com.martiansoftware.util.StringUtils
 

O

Option - class com.martiansoftware.jsap.Option.
The base class from which FlaggedOption and UnflaggedOption are derived.
Option(String) - Constructor for class com.martiansoftware.jsap.Option
Creates a new Option with the specified unique ID.
OptionConfiguration - class com.martiansoftware.jsap.ant.OptionConfiguration.
Stores/provides configuration data common to both flaggedoptions and unflaggedoptions nested inside a jsap ant task.
OptionConfiguration() - Constructor for class com.martiansoftware.jsap.ant.OptionConfiguration
Creates a new OptionConfiguration.

P

PackageStringParser - class com.martiansoftware.jsap.stringparsers.PackageStringParser.
A StringParser for parsing Packages.
PackageStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.PackageStringParser
Creates a new PackageStringParser
ParameterConfiguration - class com.martiansoftware.jsap.ant.ParameterConfiguration.
Stores/provides configuration data common to switches, flaggedoptions, and unflaggedoptions nested inside a jsap ant task.
ParameterConfiguration() - Constructor for class com.martiansoftware.jsap.ant.ParameterConfiguration
Creates a new ParameterConfiguration.
ParseException - exception com.martiansoftware.jsap.ParseException.
A JSAPException subclass notifying the application of a parse error.
ParseException() - Constructor for class com.martiansoftware.jsap.ParseException
Creates a new ParseException.
ParseException(String) - Constructor for class com.martiansoftware.jsap.ParseException
Creates a new ParseException with the specified message.
ParseException(Throwable) - Constructor for class com.martiansoftware.jsap.ParseException
Creates a new ParseException encapsulating the specified Throwable.
ParseException(String, Throwable) - Constructor for class com.martiansoftware.jsap.ParseException
Creates a new ParseException with the specified message encapsulating the specified Throwable.
ParserProperty - class com.martiansoftware.jsap.ant.ParserProperty.
Stores/provides a single name/value pair for a PropertyStringParser For detailed information on using the jsap task, see the documentation for JSAPAntTask.
ParserProperty() - Constructor for class com.martiansoftware.jsap.ant.ParserProperty
 
PropertyDefaultSource - class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource.
A DefaultSource with values defined in a java.util.Properties object.
PropertyDefaultSource(String, boolean) - Constructor for class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource
Creates a new PropertyDefaultSource by loading the specified file.
PropertyDefaultSource(Properties) - Constructor for class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource
Creates a new PropertyDefaultSource based upon the specified Properties object.
PropertyDefaultSource(InputStream, boolean) - Constructor for class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource
Creates a new PropertyDefaultSource based upon the specified InputStream.
PropertyStringParser - class com.martiansoftware.jsap.PropertyStringParser.
A StringParser subclass that provides a means for setting/getting properties.
PropertyStringParser() - Constructor for class com.martiansoftware.jsap.PropertyStringParser
 
padRight(String, int) - Static method in class com.martiansoftware.util.StringUtils
 
padRightToWidth(String, int) - Static method in class com.martiansoftware.util.StringUtils
 
parse(String[]) - Method in class com.martiansoftware.jsap.JSAP
Parses the specified command line array.
parse(String) - Method in class com.martiansoftware.jsap.JSAP
Parses the specified command line.
parse(String) - Method in class com.martiansoftware.jsap.StringParser
Parses the specified argument into an Object of the appropriate type.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.BigDecimalStringParser
Parses the specified argument into a BigDecimal.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser
Parses the specified argument into a BigInteger.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.BooleanStringParser
Converts the specified argument into a Boolean.

When parsing, the following arguments are interpreted as TRUE:
null "t" (case-insensitive) "true" (case-insensitive) "y" (case-insensitive) "yes" (case-insensitive) "1"
The following arguments are interpreted as FALSE:
"f" (case-insensitive) "false" (case-insensitive) "n" (case-insensitive) "no" (case-insensitive) "0"

All other input throws a ParseException.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.ByteStringParser
Parses the specified argument into a Byte.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.CharacterStringParser
Parses the specified argument into a Character.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.ClassStringParser
Parses the specified argument into a Class object.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.ColorStringParser
Parses java.awt.Color objects from Strings.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.DateStringParser
Parses the specified argument using either the java.text.SimpleDateFormat for the current locale (by default) or a java.text.SimpleDateFormat as defined by this PropertyStringParser's "format" property.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.DoubleStringParser
Parses the specified argument into a Double.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
Parses the specified argument, making sure it matches one of the valid options supplied to its constructor.
If the specified argument is not a valid option, a ParseException is thrown.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.FloatStringParser
Parses the specified argument into a Float.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.InetAddressStringParser
Parses the specified argument into an InetAddress.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.IntegerStringParser
Parses the specified argument into an Integer.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.LongStringParser
Parses the specified argument into a Long.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.PackageStringParser
Parses the specified argument into a Package object.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.ShortStringParser
Parses the specified argument into a Short.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.StringStringParser
Returns the specified argument as a String.
parse(String) - Method in class com.martiansoftware.jsap.stringparsers.URLStringParser
Parses the specified argument into a URL.

Q

QualifiedSwitch - class com.martiansoftware.jsap.QualifiedSwitch.
A QualifiedSwitch is a parameter that has something in common with a Switch, i.e., its presence or absence is significant, but different from a "pure" Switch it can have an additional value (or values) prefixed by a ':' sign that qualifies the Switch - making it behave like a FlaggedOption if a value is specified.
QualifiedSwitch(String, StringParser, String, boolean, char, String) - Constructor for class com.martiansoftware.jsap.QualifiedSwitch
A shortcut constructor that creates a new QualifiedSwitch and configures its most commonly used settings.
QualifiedSwitch(String) - Constructor for class com.martiansoftware.jsap.QualifiedSwitch
A shortcut constructor that creates a new QualifiedSwitch

R

REQUIRED - Static variable in class com.martiansoftware.jsap.JSAP
The parameter is required.
RequiredParameterMissingException - exception com.martiansoftware.jsap.RequiredParameterMissingException.
An exception indicating that a required parameter was missing from the supplied arguments and defaults.
RequiredParameterMissingException(String) - Constructor for class com.martiansoftware.jsap.RequiredParameterMissingException
Creates a new RequiredParameterMissingException referencing the specified parameter.
registerDefaultSource(DefaultSource) - Method in class com.martiansoftware.jsap.JSAP
Registers a new DefaultSource with this JSAP, at the end of the current DefaultSource chain, but before the defaults defined within the AbstractParameters themselves.
registerParameter(AbstractParameter) - Method in class com.martiansoftware.jsap.JSAP
Registers the specified AbstractParameter (i.e., Switch, FlaggedOption, or UnflaggedOption) with this JSAP.
required() - Method in class com.martiansoftware.jsap.Option
Returns a boolean indicating whether this Option is required.

S

ShortStringParser - class com.martiansoftware.jsap.stringparsers.ShortStringParser.
A StringParser for parsing Shorts.
ShortStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ShortStringParser
Creates a new ShortStringParser.
StringParser - class com.martiansoftware.jsap.StringParser.
Class responsible for converting Strings into Objects.
StringParser() - Constructor for class com.martiansoftware.jsap.StringParser
 
StringStringParser - class com.martiansoftware.jsap.stringparsers.StringStringParser.
A StringParser for parsing Strings.
StringStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.StringStringParser
Creates a new StringStringParser.
StringUtils - class com.martiansoftware.util.StringUtils.
 
StringUtils() - Constructor for class com.martiansoftware.util.StringUtils
 
Switch - class com.martiansoftware.jsap.Switch.
A Switch is a parameter whose presence alone is significant; another commonly used term for a Switch is "Flag." Switches use a BooleanStringParser internally, so their results can be obtained from a JSAPResult using the getBoolean() methods.

An example of a command line using a Switch is "dosomething -v", where "-v" might mean "verbose."
Switch(String) - Constructor for class com.martiansoftware.jsap.Switch
Creates a new Switch with the specified unique ID.
Switch(String, char, String) - Constructor for class com.martiansoftware.jsap.Switch
A shortcut constructor that creates a new Switch and configures all of its settings.
SwitchConfiguration - class com.martiansoftware.jsap.ant.SwitchConfiguration.
Stores/provides configuration data for switches nested inside a jsap ant task.
SwitchConfiguration() - Constructor for class com.martiansoftware.jsap.ant.SwitchConfiguration
Creates a new SwitchConfiguration.
SyntaxException - exception com.martiansoftware.jsap.SyntaxException.
An exception indicating that a syntax error was encountered in the argument list.
SyntaxException(String) - Constructor for class com.martiansoftware.jsap.SyntaxException
Creates a new SyntaxException with the specified message.
setAllowMultipleDeclarations(boolean) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets this FlaggedOption to allow or disallow multiple declarations.
setAllowmultipledeclarations(boolean) - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Specifies whether this option can be declared multiple times on the same command line.
setClassname(String) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Sets the full classname for the generated JSAP.
setDefault(String, String) - Method in class com.martiansoftware.jsap.Defaults
Sets a single default value for the parameter with the specified ID.
setDefault(String, String[]) - Method in class com.martiansoftware.jsap.Defaults
Sets an array of default values for the parameter with the specified ID.
setDefault(String[]) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets one or more default values for this parameter.
setDefault(String) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets a default value for this parameter.
setDefault(String) - Method in class com.martiansoftware.jsap.Switch
Sets a default value for this parameter.
setDefault(String[]) - Method in class com.martiansoftware.jsap.Switch
Sets one or more default values for this parameter.
setDefault(String) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets a default value for this parameter.
setDefault(String[]) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets one or more default values for this parameter.
setDefault(String) - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Adds a default value to the current list of default values for this parameter.
setGreedy(boolean) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets whether this UnflaggedOption is greedy.
setGreedy(boolean) - Method in class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
Sets whether this UnflaggedOption should be greedy.
setHelp(String) - Method in class com.martiansoftware.jsap.AbstractParameter
Sets the help text for this parameter.
setHelp(String) - Method in class com.martiansoftware.jsap.JSAP
Sets the help string manually, overriding the automatically- generated String.
setId(String) - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
Sets the unique ID for this parameter.
setIslist(boolean) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Sets whether this option is a list.
setList(boolean) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets whether this FlaggedOption is a list.
setList(boolean) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets whether this UnflaggedOption is a list.
setListSeparator(char) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets the list separator character for this FlaggedOption.
setListSeparator(char) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets the list separator character for this UnflaggedOption.
setListseparator(char) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Sets the list separator for this option, if it is a list.
setLongFlag(String) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets the long flag for this FlaggedOption.
setLongFlag(String) - Method in class com.martiansoftware.jsap.Switch
Sets the long flag for this Switch.
setLongflag(String) - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Sets the long flag for this option.
setLongflag(String) - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Sets the long flag for this switch.
setName(String) - Method in class com.martiansoftware.jsap.ant.ParserProperty
Sets the name of this property.
setProperty(String, String) - Method in class com.martiansoftware.jsap.PropertyStringParser
Sets the property with the specified key to the specified value.
setPublic(boolean) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Sets whether the generated JSAP should be declared public.
setRequired(boolean) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets whether this FlaggedOption is required.
setRequired(boolean) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets whether this UnflaggedOption is required.
setRequired(boolean) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Sets whether this option is required.
setShortFlag(char) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets the short flag for this FlaggedOption.
setShortFlag(char) - Method in class com.martiansoftware.jsap.Switch
Sets the short flag for this Switch.
setShortflag(char) - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
Sets the short flag for this option.
setShortflag(char) - Method in class com.martiansoftware.jsap.ant.SwitchConfiguration
Sets the short flag for this switch.
setSrcdir(File) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
Sets the top-level source directory under which the generated JSAP class file should be written.
setStringParser(StringParser) - Method in class com.martiansoftware.jsap.FlaggedOption
Sets the StringParser to which this FlaggedOption's parse() method should delegate.
setStringParser(StringParser) - Method in class com.martiansoftware.jsap.UnflaggedOption
Sets the StringParser to which this UnflaggedOption's parse() method should delegate.
setStringparser(String) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
Sets the StringParser for this option.
setUp() - Method in class com.martiansoftware.jsap.StringParser
Performs any initialization not handled by this StringParser's constructor.
setUp() - Method in class com.martiansoftware.jsap.TestDefaults
Configures the JSAP object for the tests.
setUp() - Method in class com.martiansoftware.jsap.stringparsers.DateStringParser
Instantiates the SimpleDateFormat to use for parsing.
setUsage(String) - Method in class com.martiansoftware.jsap.JSAP
Sets the usage string manually, overriding the automatically- generated String.
setValue(String) - Method in class com.martiansoftware.jsap.ant.ParserProperty
Sets the value of this property.
success() - Method in class com.martiansoftware.jsap.JSAPResult
Returns a boolean indicating whether the parse that produced this JSAPResult was successful.
suite() - Static method in class com.martiansoftware.jsap.TestAll
Returns a collection of all the JSAP tests, including those in subpackages.
suite() - Static method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Creates and returns a new Test based upon this class.
suite() - Static method in class com.martiansoftware.jsap.TestDefaults
Returns the tests defined in this class.
suite() - Static method in class com.martiansoftware.jsap.TestFlaggedOption
Returns a suite of all tests defined in this class.
suite() - Static method in class com.martiansoftware.jsap.TestJSAPConfiguration
Returns a suite of tests defined by this class.
suite() - Static method in class com.martiansoftware.jsap.TestOption
Returns a suite of tests defined by this class.
suite() - Static method in class com.martiansoftware.jsap.TestParser
Returns a suite of tests defined by this class.
suite() - Static method in class com.martiansoftware.jsap.TestSwitch
Returns a suite of tests defined by this class
suite() - Static method in class com.martiansoftware.jsap.TestUsageString
Returns a suite of tests defined by this class.
suite() - Static method in class com.martiansoftware.jsap.defaultsources.TestAll
 
suite() - Static method in class com.martiansoftware.jsap.stringparsers.TestAll
Returns a suite of all tests in the stringparsers package.

T

TestAll - class com.martiansoftware.jsap.TestAll.
Runs all of the JSAP tests, including those in sub-packages.
TestAll() - Constructor for class com.martiansoftware.jsap.TestAll
 
TestAll - class com.martiansoftware.jsap.defaultsources.TestAll.
 
TestAll() - Constructor for class com.martiansoftware.jsap.defaultsources.TestAll
 
TestAll - class com.martiansoftware.jsap.stringparsers.TestAll.
Contains all of the tests in the stringparsers package.
TestAll() - Constructor for class com.martiansoftware.jsap.stringparsers.TestAll
 
TestColorStringParser - class com.martiansoftware.jsap.stringparsers.TestColorStringParser.
A series of tests for the ColorStringParser
TestColorStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.TestColorStringParser
Constructor for TestColorStringParser.
TestCommandLineTokenizer - class com.martiansoftware.jsap.TestCommandLineTokenizer.
This junit TestCase runs a barrage of tests against the CommandLineTokenizer.
TestCommandLineTokenizer() - Constructor for class com.martiansoftware.jsap.TestCommandLineTokenizer
 
TestDefaults - class com.martiansoftware.jsap.TestDefaults.
Tests JSAP's handling of default values.
TestDefaults() - Constructor for class com.martiansoftware.jsap.TestDefaults
 
TestFlaggedOption - class com.martiansoftware.jsap.TestFlaggedOption.
 
TestFlaggedOption(String) - Constructor for class com.martiansoftware.jsap.TestFlaggedOption
Creates a TestCase with the specified name.
TestJSAPConfiguration - class com.martiansoftware.jsap.TestJSAPConfiguration.
Tests the JSAPConfiguration class
TestJSAPConfiguration() - Constructor for class com.martiansoftware.jsap.TestJSAPConfiguration
 
TestLongStringParser - class com.martiansoftware.jsap.stringparsers.TestLongStringParser.
A series of tests for the LongStringParser
TestLongStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.TestLongStringParser
Constructor for TestLongStringParser.
TestOption - class com.martiansoftware.jsap.TestOption.
Tests the Option class
TestOption() - Constructor for class com.martiansoftware.jsap.TestOption
 
TestParser - class com.martiansoftware.jsap.TestParser.
Tests the Parser class.
TestParser() - Constructor for class com.martiansoftware.jsap.TestParser
 
TestPropertyDefaultSource - class com.martiansoftware.jsap.defaultsources.TestPropertyDefaultSource.
 
TestPropertyDefaultSource() - Constructor for class com.martiansoftware.jsap.defaultsources.TestPropertyDefaultSource
 
TestSwitch - class com.martiansoftware.jsap.TestSwitch.
Tests the Switch class.
TestSwitch(String) - Constructor for class com.martiansoftware.jsap.TestSwitch
Creates a new test case with the specified name.
TestUsageString - class com.martiansoftware.jsap.TestUsageString.
Tests the ability to automatically create usage information.
TestUsageString(String) - Constructor for class com.martiansoftware.jsap.TestUsageString
Creates a new TestCase with the specified name.
tearDown() - Method in class com.martiansoftware.jsap.StringParser
Performs any cleanup necessary for this StringParser.
tearDown() - Method in class com.martiansoftware.jsap.TestDefaults
Cleans up the JSAP object.
tearDown() - Method in class com.martiansoftware.jsap.stringparsers.DateStringParser
Destroys the SimpleDateFormat used for parsing.
test1() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of [this is a test].
test10() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of ["this is a test]
test2() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for corect parsing of [this is a "test"]
test3() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of ["this is a test"]
test4() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of [this is a "test]
test5() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of [thi\s is a \"test]
test6() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of [thi\s is a \"test\\]
test7() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of [thi\s is a \"test\\\"]
test8() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of a null command line.
test9() - Method in class com.martiansoftware.jsap.TestCommandLineTokenizer
Tests for correct parsing of a whitespace-only command line.
testBasicParse() - Method in class com.martiansoftware.jsap.stringparsers.TestLongStringParser
Tests the ability to parse tuples of integers representing RGB values.
testByName() - Method in class com.martiansoftware.jsap.stringparsers.TestColorStringParser
Tests the ability to parse color names as in java.awt.Color fields.
testConfig() - Method in class com.martiansoftware.jsap.TestDefaults
Ensures that the setUp() method was successful.
testConfigurationGymnastics() - Method in class com.martiansoftware.jsap.TestJSAPConfiguration
Tests various configuration situations, such as changing properties of registered parameters, retrieving parameters, etc.
testDefaults2() - Method in class com.martiansoftware.jsap.TestDefaults
Another test of parameter-level defaults.
testFloatRGB() - Method in class com.martiansoftware.jsap.stringparsers.TestColorStringParser
Tests the ability to parse tuples of floats representing RGB values.
testHexRGB() - Method in class com.martiansoftware.jsap.stringparsers.TestColorStringParser
Tests the ability to parse hexadecimal strings as RGB values.
testID() - Method in class com.martiansoftware.jsap.TestSwitch
Tests the ability to retrieve the Switch's ID.
testIntegerRGB() - Method in class com.martiansoftware.jsap.stringparsers.TestColorStringParser
Tests the ability to parse tuples of integers representing RGB values.
testLongFlag() - Method in class com.martiansoftware.jsap.TestFlaggedOption
Tests the ability to set/get long flags.
testLongFlag() - Method in class com.martiansoftware.jsap.TestSwitch
Tests the ability to set/get the Switch's long flag.
testMultipleDeclarations() - Method in class com.martiansoftware.jsap.TestParser
Tests the ability to parse when allowMultipleDeclarations is set to true.
testOneLevelDefaults() - Method in class com.martiansoftware.jsap.TestDefaults
Tests a single level of property defaults.
testParser() - Method in class com.martiansoftware.jsap.TestParser
Tests the parser with both a String and an Integer option.
testParsing() - Method in class com.martiansoftware.jsap.TestOption
Tests the ability to parse via the option's parse() method.
testRequired() - Method in class com.martiansoftware.jsap.TestDefaults
Tests JSAP's enforcing of required parameters.
testSettersAndGetters() - Method in class com.martiansoftware.jsap.TestOption
Tests the various setters and getters on an option.
testShortFlag() - Method in class com.martiansoftware.jsap.TestFlaggedOption
Tests the ability to set/get short flags.
testShortFlag() - Method in class com.martiansoftware.jsap.TestSwitch
Tests the ability to set/get the Switch's short flag.
testSimpleDefault() - Method in class com.martiansoftware.jsap.TestDefaults
Tests the parameter-level defaults.
testSwitchParse() - Method in class com.martiansoftware.jsap.TestSwitch
Tests the parsing ability of the Switch.
testUnexpectedProperties() - Method in class com.martiansoftware.jsap.defaultsources.TestPropertyDefaultSource
 
testUsage1() - Method in class com.martiansoftware.jsap.TestUsageString
Tests usage info for a single option, both required and not required.
testUsage2() - Method in class com.martiansoftware.jsap.TestUsageString
Tests usage info for a Switch.
toString() - Method in class com.martiansoftware.jsap.JSAP
Returns an automatically generated usage description based upon this JSAP's current configuration.
tokenize(String) - Static method in class com.martiansoftware.jsap.CommandLineTokenizer
Parses the specified command line into an array of individual arguments.

U

URLStringParser - class com.martiansoftware.jsap.stringparsers.URLStringParser.
A StringParser for parsing java.net.URL objects.
URLStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.URLStringParser
Creates a new URLStringParser.
UnflaggedOption - class com.martiansoftware.jsap.UnflaggedOption.
An option whose meaning is derived from its position in the argument list rather than a flag that precedes it.
UnflaggedOption(String) - Constructor for class com.martiansoftware.jsap.UnflaggedOption
Creates a new UnflaggedOption with the specified unique ID.
UnflaggedOption(String, StringParser, String, boolean, boolean) - Constructor for class com.martiansoftware.jsap.UnflaggedOption
A shortcut constructor that creates a new UnflaggedOption and configures its most commonly used settings.
UnflaggedOptionConfiguration - class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration.
Stores/provides configuration data for unflaggedoptions nested inside a jsap ant task.
UnflaggedOptionConfiguration() - Constructor for class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
Creates a new UnflaggedOptionConfiguration.
UnknownFlagException - exception com.martiansoftware.jsap.UnknownFlagException.
An exception indicating that a unknown flag has been specified.
UnknownFlagException(String) - Constructor for class com.martiansoftware.jsap.UnknownFlagException
Creates a new UnknownFlagException referencing the specified parameter.
UnknownFlagException(Character) - Constructor for class com.martiansoftware.jsap.UnknownFlagException
Creates a new UnknownFlagException referencing the specified parameter.
unregisterDefaultSource(DefaultSource) - Method in class com.martiansoftware.jsap.JSAP
Removes the specified DefaultSource from this JSAP's DefaultSource chain.
unregisterParameter(AbstractParameter) - Method in class com.martiansoftware.jsap.JSAP
Unregisters the specified AbstractParameter (i.e., Switch, FlaggedOption, or UnflaggedOption) from this JSAP.

W

wrapToList(String, int) - Static method in class com.martiansoftware.util.StringUtils
 

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

Copyright © 2002-2004, Martian Software, Inc.. All Rights Reserved.
For the latest version and documentation, please visit http://www.martiansoftware.com/jsap