Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 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.Parameter
-
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.
- addParameter(ParameterConfig) - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- 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
- BIGDECIMAL_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
BigDecimalStringParser
. - BigDecimalStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing BigDecimals. - BigDecimalStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BigDecimalStringParser
-
Deprecated.
- BIGINTEGER_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
BigIntegerStringParser
. - BigIntegerStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing BigIntegers. - BigIntegerStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser
-
Deprecated.Use
BigIntegerStringParser.getParser()
or, even better,JSAP.BIGINTEGER_PARSER
. - BOOLEAN_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
BooleanStringParser
. - BooleanStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Booleans. - BooleanStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.BooleanStringParser
-
Deprecated.Use
BooleanStringParser.getParser()
or, even better,JSAP.BOOLEAN_PARSER
. - BYTE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
ByteStringParser
. - ByteStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Bytes. - ByteStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ByteStringParser
-
Deprecated.Use
ByteStringParser.getParser()
or, even better,JSAP.BYTE_PARSER
.
C
- CHARACTER_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
CharacterStringParser
. - CharacterStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Characters. - CharacterStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.CharacterStringParser
-
Deprecated.Use
CharacterStringParser.getParser()
or, even better,JSAP.CHARACTER_PARSER
. - CLASS_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
ClassStringParser
. - ClassStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Class objects. - ClassStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ClassStringParser
-
Deprecated.Use
ClassStringParser.getParser()
or, even better,JSAP.CLASS_PARSER
. - COLOR_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
ColorStringParser
. - ColorStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing java.awt.Color objects. - ColorStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ColorStringParser
-
Deprecated.Use
ColorStringParser.getParser()
or, even better,JSAP.COLOR_PARSER
. - 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.jsap.xml - package com.martiansoftware.jsap.xml
- com.martiansoftware.util - package com.martiansoftware.util
- CommandLineTokenizer - Class in com.martiansoftware.jsap
-
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. - configure(JSAP, URL) - Static method in class com.martiansoftware.jsap.xml.JSAPConfig
-
Loads a JSAP configuration from the xml at the specified URL, and configures the specified JSAP object accordingly
- 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
- contains(String) - Method in class com.martiansoftware.jsap.JSAPResult
-
Returns true if this JSAPResult contains any results for the specified id.
- 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
- DateStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing java.util.Date objects. - DateStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.DateStringParser
-
Deprecated.
- declaredListSeparator() - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
-
Returns a boolean indicating whether the list separator character has been specified by the user.
- DEFAULT_LISTSEPARATOR - Static variable in class com.martiansoftware.jsap.JSAP
-
The default separator for list parameters (equivalent to java.io.File.pathSeparatorChar)
- DEFAULT_PARAM_HELP_SEPARATOR - Static variable in class com.martiansoftware.jsap.JSAP
-
The default separator between parameters in generated help (a newline by default)
- DEFAULT_SCREENWIDTH - Static variable in class com.martiansoftware.jsap.JSAP
-
The default screen width used for formatting help.
- Defaults - Class in com.martiansoftware.jsap
-
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.
- DefaultSource - Interface in com.martiansoftware.jsap
-
An interface describing an object as being able to produce a set of default values.
- DefaultValue - Class in com.martiansoftware.jsap.ant
-
Provides a means of specifying default values for the jsap task containing <default> elements.
- DefaultValue() - Constructor for class com.martiansoftware.jsap.ant.DefaultValue
- DOUBLE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
DoubleStringParser
. - DoubleStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Doubles. - DoubleStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.DoubleStringParser
-
Deprecated.Use
DoubleStringParser.getParser()
or, even better,JSAP.DOUBLE_PARSER
.
E
- EnumeratedStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
that enforces a limited set of String options for its values. - EnumeratedStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Deprecated.
- EnumeratedStringParser(String, boolean) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Deprecated.
- EnumeratedStringParser(String, boolean, boolean) - Constructor for class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Deprecated.
- Example - Search tag in class com.martiansoftware.jsap.ant.JSAPAntTask
- Section
- Example1 - Class in com.martiansoftware.jsap.examples
- Example1() - Constructor for class com.martiansoftware.jsap.examples.Example1
- ExceptionMap - Interface in com.martiansoftware.jsap
-
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
- FileStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A StringParser for parsing
File
objects. - FileStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.FileStringParser
-
Deprecated.
- finalize() - Method in class com.martiansoftware.jsap.JSAP
-
Unregisters all registered AbstractParameters, allowing them to perform their cleanup.
- Flagged - Interface in com.martiansoftware.jsap
-
Marks an argument as being "flagged" - that is, as having its value on the command line preceded by an indicator.
- FlaggedOption - Class in com.martiansoftware.jsap
-
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.
- FlaggedOption(String, StringParser, String, boolean, char, String, String) - Constructor for class com.martiansoftware.jsap.FlaggedOption
-
A shortcut constructor that creates a new FlaggedOption and configures its most commonly used settings, including help.
- FlaggedOptionConfiguration - Class in com.martiansoftware.jsap.ant
-
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.
- FLOAT_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
FloatStringParser
. - FloatStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Floats. - FloatStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.FloatStringParser
-
Deprecated.Use
FloatStringParser.getParser()
or, even better,JSAP.FLOAT_PARSER
. - ForNameStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
that passes the argument to a static method of signatureforName(String)
of a specified class.
G
- Generating a JSAP from ANT - Search tag in class com.martiansoftware.jsap.JSAP
- Section
- 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(char) - Method in class com.martiansoftware.jsap.JSAP
-
Returns the requested Switch or FlaggedOption with the specified short flag.
- getByShortFlag(Character) - 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.Parameter
-
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() - 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 interface com.martiansoftware.jsap.DefaultSource
-
Returns a set of default values given the configuration described by the specified IDMap.
- 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.
- getFile(String) - Method in class com.martiansoftware.jsap.JSAPResult
-
Returns the first File value associated with the specified id.
- getFile(String, File) - Method in class com.martiansoftware.jsap.JSAPResult
-
Returns the first File value associated with the specified id.
- getFileArray(String) - Method in class com.martiansoftware.jsap.JSAPResult
-
Returns an array of File values associated with the specified id.
- getFlag() - Method in exception 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.JSAP
-
A shortcut method for calling getHelp(80, "\n").
- getHelp() - Method in class com.martiansoftware.jsap.Parameter
-
Returns a description of the option's usage.
- getHelp() - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- getHelp(int) - Method in class com.martiansoftware.jsap.JSAP
-
A shortcut method for calling getHelp(screenWidth, "\n").
- getHelp(int, String) - 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.ant.ParameterConfiguration
-
Returns the unique ID for this parameter.
- getID() - Method in exception 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.Parameter
-
Returns this parameter's unique ID.
- getID() - Method in exception class com.martiansoftware.jsap.RequiredParameterMissingException
-
Returns the unique ID of the parameter that was missing.
- getID() - Method in exception class com.martiansoftware.jsap.UnspecifiedParameterException
-
Returns the unique ID of the parameter whose retrieval was attempted.
- 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(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.
- 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.
- 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.
- 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.ant.OptionConfiguration
-
Returns the list separator character for this option.
- getListSeparator() - Method in class com.martiansoftware.jsap.Option
-
Returns the current 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 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.
- 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.
- 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 Parameter (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.
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.BigDecimalStringParser
-
Returns a
BigDecimalStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser
-
Returns a
BigIntegerStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.BooleanStringParser
-
Returns a
BooleanStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ByteStringParser
-
Returns a
ByteStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.CharacterStringParser
-
Returns a
CharacterStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ClassStringParser
-
Returns a
ClassStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ColorStringParser
-
Returns a
ColorStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.DateStringParser
-
Returns a
DateStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.DoubleStringParser
-
Returns a
DoubleStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.FileStringParser
-
Returns a new
FileStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.FloatStringParser
-
Returns a
FloatStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.InetAddressStringParser
-
Returns a
InetAddressStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.IntegerStringParser
-
Returns a
IntegerStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.IntSizeStringParser
-
Returns the only instance of an
IntSizeStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.LongSizeStringParser
-
Returns the only instance of a
LongSizeStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.LongStringParser
-
Returns a
LongStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.PackageStringParser
-
Returns a
PackageStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ShortStringParser
-
Returns a
ShortStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.StringStringParser
-
Returns a
StringStringParser
. - getParser() - Static method in class com.martiansoftware.jsap.stringparsers.URLStringParser
-
Returns a
URLStringParser
. - getParser(Class) - Static method in class com.martiansoftware.jsap.stringparsers.ForNameStringParser
-
Returns a class
forName()
string parser. - getParser(String) - Static method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Returns an EnumeratedParameterParser with parameter "caseSensitive" set to false and "checkOptionChars" set to true.
- getParser(String, boolean) - Static method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Returns an EnumeratedParameterParser with parameter "checkOptionChars" set to true.
- getParser(String, boolean, boolean) - Static method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Returns an EnumeratedParameterParser.
- 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.
- getScreenWidth() - Method in class com.martiansoftware.jsap.SimpleJSAP
-
Returns the current screen width.
- 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 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.
- 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.
- 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.ant.OptionConfiguration
-
Returns the classname of the StringParser for this option.
- 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.
- getSyntax() - Method in class com.martiansoftware.jsap.FlaggedOption
-
Returns syntax instructions for this FlaggedOption.
- getSyntax() - Method in class com.martiansoftware.jsap.Parameter
-
A convenience method for automatically generating syntax information based upon a JSAP configuration.
- 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.
- getUnflaggedOptionsIterator() - Method in class com.martiansoftware.jsap.JSAP
-
Returns an Iterator over all UnflaggedOptions currently registered with this JSAP.
- 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.
- getUsage() - Method in class com.martiansoftware.jsap.JSAP
-
Returns an automatically generated usage description based upon this JSAP's current configuration.
- getUsage() - Method in class com.martiansoftware.jsap.Parameter
-
Deprecated.use getSyntax() instead
- getUsage() - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- getUsageName() - Method in class com.martiansoftware.jsap.Parameter
-
Returns the name of this AbstractParameter for the purposes of usage information.
- 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.
- GREEDY - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter consumes the command line.
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
- 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.
- IDMap - Class in com.martiansoftware.jsap
-
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 Class in com.martiansoftware.jsap
-
An exception indicating that a parameter has illegally been declared multiple times.
- IllegalMultipleDeclarationException(String) - Constructor for exception class com.martiansoftware.jsap.IllegalMultipleDeclarationException
-
Creates a new IllegalMultipleDeclarationException referencing the specified parameter.
- INETADDRESS_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
InetAddressStringParser
. - InetAddressStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing java.net.InetAddress objects. - InetAddressStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.InetAddressStringParser
-
Deprecated.Use
InetAddressStringParser.getParser()
or, even better,JSAP.INETADDRESS_PARSER
. - INTEGER_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
IntegerStringParser
. - IntegerStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Integers. - IntegerStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.IntegerStringParser
-
Deprecated.Use
IntegerStringParser.getParser()
or, even better,JSAP.INTEGER_PARSER
. - INTSIZE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
IntSizeStringParser
. - IntSizeStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
that works likeLongSizeStringParser
, but additionally checks that the result is not larger thanInteger.MAX_VALUE
. - 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 in com.martiansoftware.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.
- JSAP(String) - Constructor for class com.martiansoftware.jsap.JSAP
-
Creates a new JSAP configured as specified in the referenced xml.
- JSAP(URL) - Constructor for class com.martiansoftware.jsap.JSAP
-
Creates a new JSAP configured as specified in the referenced xml.
- JSAPAntTask - Class in com.martiansoftware.jsap.ant
-
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.
- JSAPConfig - Class in com.martiansoftware.jsap.xml
-
Provides support for loading JSAP configurations at runtime via an xml file.
- JSAPConfig() - Constructor for class com.martiansoftware.jsap.xml.JSAPConfig
- JSAPException - Exception Class in com.martiansoftware.jsap
-
The base class for all of JSAP's exceptions.
- JSAPException() - Constructor for exception class com.martiansoftware.jsap.JSAPException
-
Creates a new JSAPException.
- JSAPException(String) - Constructor for exception class com.martiansoftware.jsap.JSAPException
-
Creates a new JSAPException with the specified message.
- JSAPException(String, Throwable) - Constructor for exception class com.martiansoftware.jsap.JSAPException
-
Creates a new JSAPException with the specified message encapsulating the specified Throwable.
- JSAPException(Throwable) - Constructor for exception class com.martiansoftware.jsap.JSAPException
-
Creates a new JSAPException encapsulating the specified Throwable.
- JSAPResult - Class in com.martiansoftware.jsap
-
Encapsulates the results of JSAP's parse() methods.
L
- LIST - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter is a list.
- LONG_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
LongStringParser
. - LONGSIZE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
LongSizeStringParser
. - LongSizeStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
that lets the user specify sizes with an optional unit. - LongStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Longs. - LongStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.LongStringParser
-
Deprecated.Use
LongStringParser.getParser()
or, even better,JSAP.LONG_PARSER
.
M
- main(String[]) - Static method in class com.martiansoftware.jsap.examples.Example1
- 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.xml.TryDumpXML
- main(String[]) - Static method in class com.martiansoftware.jsap.xml.TryLoadXML
- main(String[]) - Static method in class com.martiansoftware.util.StringUtils
- messagePrinted() - Method in class com.martiansoftware.jsap.SimpleJSAP
-
Returns true if the last parsing caused the a message to be printed.
- MULTIPLEDECLARATIONS - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter allows multiple declarations.
- mustBeDirectory() - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- MUSTBEDIRECTORY - Static variable in class com.martiansoftware.jsap.stringparsers.FileStringParser
- mustBeFile() - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- MUSTBEFILE - Static variable in class com.martiansoftware.jsap.stringparsers.FileStringParser
- mustExist() - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- MUSTEXIST - Static variable in class com.martiansoftware.jsap.stringparsers.FileStringParser
N
- NO_DEFAULT - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter has no default value.
- NO_HELP - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter has no help text.
- 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
- 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.
O
- Option - Class in com.martiansoftware.jsap
-
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 in com.martiansoftware.jsap.ant
-
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
- PACKAGE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
PackageStringParser
. - PackageStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Packages. - PackageStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.PackageStringParser
-
Deprecated.Use
PackageStringParser.getParser()
or, even better,JSAP.PACKAGE_PARSER
. - padRight(String, int) - Static method in class com.martiansoftware.util.StringUtils
- padRightToWidth(String, int) - Static method in class com.martiansoftware.util.StringUtils
- Parameter - Class in com.martiansoftware.jsap
-
Top-level abstraction of a parameter.
- Parameter(String) - Constructor for class com.martiansoftware.jsap.Parameter
-
Creates a new Parameter.
- ParameterConfiguration - Class in com.martiansoftware.jsap.ant
-
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.
- parameters() - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- parse(String) - Method in class com.martiansoftware.jsap.JSAP
-
Parses the specified command line.
- parse(String) - Method in class com.martiansoftware.jsap.SimpleJSAP
- 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.
- 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.
- parse(String) - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
-
Parses the specified argument into a File.
- 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.ForNameStringParser
- 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.IntSizeStringParser
- parse(String) - Method in class com.martiansoftware.jsap.stringparsers.LongSizeStringParser
- 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.
- parse(String[]) - Method in class com.martiansoftware.jsap.JSAP
-
Parses the specified command line array.
- parse(String[]) - Method in class com.martiansoftware.jsap.SimpleJSAP
- ParseException - Exception Class in com.martiansoftware.jsap
-
A JSAPException subclass notifying the application of a parse error.
- ParseException() - Constructor for exception class com.martiansoftware.jsap.ParseException
-
Creates a new ParseException.
- ParseException(String) - Constructor for exception class com.martiansoftware.jsap.ParseException
-
Creates a new ParseException with the specified message.
- ParseException(String, Throwable) - Constructor for exception class com.martiansoftware.jsap.ParseException
-
Creates a new ParseException with the specified message encapsulating the specified Throwable.
- ParseException(Throwable) - Constructor for exception class com.martiansoftware.jsap.ParseException
-
Creates a new ParseException encapsulating the specified Throwable.
- ParserProperty - Class in com.martiansoftware.jsap.ant
-
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
- parseSize(CharSequence) - Static method in class com.martiansoftware.jsap.stringparsers.LongSizeStringParser
-
Parses a size specified using units (e.g., K, Ki, M, Mi,…).
- PropertyDefaultSource - Class in com.martiansoftware.jsap.defaultsources
-
A DefaultSource with values defined in a java.util.Properties object.
- PropertyDefaultSource(InputStream, boolean) - Constructor for class com.martiansoftware.jsap.defaultsources.PropertyDefaultSource
-
Creates a new PropertyDefaultSource based upon the specified InputStream.
- 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.
- PropertyStringParser - Class in com.martiansoftware.jsap
-
A
StringParser
subclass that provides a means for setting/getting properties. - PropertyStringParser() - Constructor for class com.martiansoftware.jsap.PropertyStringParser
Q
- QualifiedSwitch - Class in com.martiansoftware.jsap
-
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) - Constructor for class com.martiansoftware.jsap.QualifiedSwitch
-
A shortcut constructor that creates a new QualifiedSwitch
- 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, StringParser, String, boolean, char, String, String) - Constructor for class com.martiansoftware.jsap.QualifiedSwitch
-
A shortcut constructor that creates a new QualifiedSwitch and configures its most commonly used settings, including help.
R
- 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(Parameter) - Method in class com.martiansoftware.jsap.JSAP
-
Registers the specified Parameter (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.
- REQUIRED - Static variable in class com.martiansoftware.jsap.JSAP
-
The parameter is required.
- RequiredParameterMissingException - Exception Class in com.martiansoftware.jsap
-
An exception indicating that a required parameter was missing from the supplied arguments and defaults.
- RequiredParameterMissingException(String) - Constructor for exception class com.martiansoftware.jsap.RequiredParameterMissingException
-
Creates a new RequiredParameterMissingException referencing the specified parameter.
S
- setAllowmultipledeclarations(boolean) - Method in class com.martiansoftware.jsap.ant.FlaggedOptionConfiguration
-
Specifies whether this option can be declared multiple times on the same command line.
- setAllowMultipleDeclarations(boolean) - Method in class com.martiansoftware.jsap.FlaggedOption
-
Sets this FlaggedOption to allow or disallow multiple declarations.
- setClassname(String) - Method in class com.martiansoftware.jsap.ant.JSAPAntTask
-
Sets the full classname for the generated JSAP.
- setDefault(String) - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
-
Adds a default value to the current list of 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.UnflaggedOption
-
Sets a default value for this parameter.
- 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.Switch
-
Sets one or more default values for this parameter.
- setDefault(String[]) - Method in class com.martiansoftware.jsap.UnflaggedOption
-
Sets one or more default values for this parameter.
- 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.
- setGreedy(boolean) - Method in class com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration
-
Sets whether this UnflaggedOption should be greedy.
- setGreedy(boolean) - Method in class com.martiansoftware.jsap.UnflaggedOption
-
Sets whether this UnflaggedOption is greedy.
- setHelp(String) - Method in class com.martiansoftware.jsap.JSAP
-
Sets the help string manually, overriding the automatically- generated String.
- setHelp(String) - Method in class com.martiansoftware.jsap.Parameter
-
Sets the help text for this parameter.
- setHelp(String) - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- 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.ant.OptionConfiguration
-
Sets the list separator for this option, if it 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.
- 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.
- 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.
- setMustBeDirectory(boolean) - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- setMustBeFile(boolean) - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- setMustExist(boolean) - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- 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.ant.OptionConfiguration
-
Sets whether this option is required.
- 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.
- setScreenWidth(int) - Method in class com.martiansoftware.jsap.SimpleJSAP
-
Sets the screen width.
- 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.
- 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.
- 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(String) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
-
Sets the StringParser for this option.
- 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.
- 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.stringparsers.DateStringParser
-
Instantiates the SimpleDateFormat to use for parsing.
- setUp() - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- setUp() - Method in class com.martiansoftware.jsap.TestDefaults
-
Configures the JSAP object for the tests.
- setUsage(String) - Method in class com.martiansoftware.jsap.JSAP
-
Sets the usage string manually, overriding the automatically- generated String.
- setUsage(String) - Method in class com.martiansoftware.jsap.xml.JSAPConfig
- setUsageName(String) - Method in class com.martiansoftware.jsap.FlaggedOption
-
Sets the name that will be displayed when getSyntax() is called
- setUsageName(String) - Method in class com.martiansoftware.jsap.UnflaggedOption
-
Sets the name that will be displayed when getUsage() is called
- setValue(String) - Method in class com.martiansoftware.jsap.ant.ParserProperty
-
Sets the value of this property.
- SHORT_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
ShortStringParser
. - ShortStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Shorts. - ShortStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ShortStringParser
-
Deprecated.Use
ShortStringParser.getParser()
or, even better,JSAP.SHORT_PARSER
. - SimpleJSAP - Class in com.martiansoftware.jsap
-
A simple interface to
JSAP
that handles directly help, explanation and an array of parameters. - SimpleJSAP(String) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with a help switch, no explanation and default screen width.
- SimpleJSAP(String, String) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with default screen width.
- SimpleJSAP(String, String, Parameter[]) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with default screen width.
- STRING_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
StringStringParser
. - StringParser - Class in com.martiansoftware.jsap
-
Class responsible for converting Strings into Objects.
- StringParser() - Constructor for class com.martiansoftware.jsap.StringParser
- StringStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing Strings. - StringStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.StringStringParser
-
Deprecated.Use
StringStringParser.getParser()
or, even better,JSAP.STRING_PARSER
. - StringUtils - Class in com.martiansoftware.util
- StringUtils() - Constructor for class com.martiansoftware.util.StringUtils
- 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.defaultsources.TestAll
- suite() - Static method in class com.martiansoftware.jsap.stringparsers.TestAll
-
Returns a suite of all tests in the stringparsers package.
- 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.
- Switch - Class in com.martiansoftware.jsap
-
A Switch is a parameter whose presence alone is significant; another commonly used term for a Switch is "Flag".
- 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.
- Switch(String, char, String, String) - Constructor for class com.martiansoftware.jsap.Switch
-
A shortcut constructor that creates a new Switch and configures all of its settings, including help.
- SwitchConfiguration - Class in com.martiansoftware.jsap.ant
-
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 Class in com.martiansoftware.jsap
-
An exception indicating that a syntax error was encountered in the argument list.
- SyntaxException(String) - Constructor for exception class com.martiansoftware.jsap.SyntaxException
-
Creates a new SyntaxException with the specified message.
T
- tearDown() - Method in class com.martiansoftware.jsap.StringParser
-
Performs any cleanup necessary for this StringParser.
- tearDown() - Method in class com.martiansoftware.jsap.stringparsers.DateStringParser
-
Destroys the SimpleDateFormat used for parsing.
- tearDown() - Method in class com.martiansoftware.jsap.stringparsers.FileStringParser
- tearDown() - Method in class com.martiansoftware.jsap.TestDefaults
-
Cleans up the JSAP object.
- 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.
- TestAll - Class in com.martiansoftware.jsap.defaultsources
- TestAll - Class in com.martiansoftware.jsap.stringparsers
-
Contains all of the tests in the stringparsers package.
- TestAll - Class in com.martiansoftware.jsap
-
Runs all of the JSAP tests, including those in sub-packages.
- TestAll() - Constructor for class com.martiansoftware.jsap.defaultsources.TestAll
- TestAll() - Constructor for class com.martiansoftware.jsap.stringparsers.TestAll
- TestAll() - Constructor for class com.martiansoftware.jsap.TestAll
- 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.
- TestColorStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A series of tests for the ColorStringParser
- TestColorStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.TestColorStringParser
-
Constructor for TestColorStringParser.
- TestCommandLineTokenizer - Class in com.martiansoftware.jsap
-
This junit TestCase runs a barrage of tests against the CommandLineTokenizer.
- TestCommandLineTokenizer() - Constructor for class com.martiansoftware.jsap.TestCommandLineTokenizer
- 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.
- TestDefaults - Class in com.martiansoftware.jsap
-
Tests JSAP's handling of default values.
- TestDefaults() - Constructor for class com.martiansoftware.jsap.TestDefaults
- testDefaults2() - Method in class com.martiansoftware.jsap.TestDefaults
-
Another test of parameter-level defaults.
- TestFlaggedOption - Class in com.martiansoftware.jsap
- TestFlaggedOption(String) - Constructor for class com.martiansoftware.jsap.TestFlaggedOption
-
Creates a TestCase with the specified name.
- 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.
- TestJSAPConfiguration - Class in com.martiansoftware.jsap
-
Tests the JSAPConfiguration class
- TestJSAPConfiguration() - Constructor for class com.martiansoftware.jsap.TestJSAPConfiguration
- 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.
- TestLongStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A series of tests for the LongStringParser
- TestLongStringParser(String) - Constructor for class com.martiansoftware.jsap.stringparsers.TestLongStringParser
-
Constructor for TestLongStringParser.
- 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.
- TestOption - Class in com.martiansoftware.jsap
-
Tests the Option class
- TestOption() - Constructor for class com.martiansoftware.jsap.TestOption
- testParser() - Method in class com.martiansoftware.jsap.TestParser
-
Tests the parser with both a String and an Integer option.
- TestParser - Class in com.martiansoftware.jsap
-
Tests the Parser class.
- TestParser() - Constructor for class com.martiansoftware.jsap.TestParser
- testParsing() - Method in class com.martiansoftware.jsap.TestOption
-
Tests the ability to parse via the option's parse() method.
- TestPropertyDefaultSource - Class in com.martiansoftware.jsap.defaultsources
- TestPropertyDefaultSource() - Constructor for class com.martiansoftware.jsap.defaultsources.TestPropertyDefaultSource
- 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.
- TestSwitch - Class in com.martiansoftware.jsap
-
Tests the Switch class.
- TestSwitch(String) - Constructor for class com.martiansoftware.jsap.TestSwitch
-
Creates a new test case with the specified name.
- 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.
- TestUsageString - Class in com.martiansoftware.jsap
-
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.
- tokenize(String) - Static method in class com.martiansoftware.jsap.CommandLineTokenizer
-
Parses the specified command line into an array of individual arguments.
- toString() - Method in class com.martiansoftware.jsap.JSAP
-
Returns an automatically generated usage description based upon this JSAP's current configuration.
- TryDumpXML - Class in com.martiansoftware.jsap.xml
-
Sends a JSAPConfig to System.out as xml (for test purposes)
- TryDumpXML() - Constructor for class com.martiansoftware.jsap.xml.TryDumpXML
- TryLoadXML - Class in com.martiansoftware.jsap.xml
-
Loads a silly example JSAP from xml and displays its help message
- TryLoadXML() - Constructor for class com.martiansoftware.jsap.xml.TryLoadXML
U
- UnflaggedOption - Class in com.martiansoftware.jsap
-
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, boolean, String) - Constructor for class com.martiansoftware.jsap.UnflaggedOption
-
A shortcut constructor that creates a new non-greedy UnflaggedOption with no default value and configures its most commonly used settings.
- 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.
- UnflaggedOption(String, StringParser, String, boolean, boolean, String) - Constructor for class com.martiansoftware.jsap.UnflaggedOption
-
A shortcut constructor that creates a new UnflaggedOption and configures its most commonly used settings.
- UnflaggedOptionConfiguration - Class in com.martiansoftware.jsap.ant
-
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 Class in com.martiansoftware.jsap
-
An exception indicating that a unknown flag has been specified.
- UnknownFlagException(Character) - Constructor for exception class com.martiansoftware.jsap.UnknownFlagException
-
Creates a new UnknownFlagException referencing the specified parameter.
- UnknownFlagException(String) - Constructor for exception 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(Parameter) - Method in class com.martiansoftware.jsap.JSAP
-
Unregisters the specified Parameter (i.e., Switch, FlaggedOption, or UnflaggedOption) from this JSAP.
- UnspecifiedParameterException - Exception Class in com.martiansoftware.jsap
-
An exception thrown when an argument that requires a conversion (e.g., an integer) has no associated value, but it is retrieved by means of a type-specified method (e.g.,
JSAPResult.getInt(String)
). - UnspecifiedParameterException(String) - Constructor for exception class com.martiansoftware.jsap.UnspecifiedParameterException
-
Creates a new
UnspecifiedParameterException
referencing the specified parameter. - URL_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
The only instance of a
URLStringParser
. - URLStringParser - Class in com.martiansoftware.jsap.stringparsers
-
A
StringParser
for parsing java.net.URL objects. - URLStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.URLStringParser
-
Deprecated.Use
getParser()
or, even better,JSAP.URL_PARSER
. - userSpecified(String) - Method in class com.martiansoftware.jsap.JSAPResult
-
Returns true if this JSAPResult contains any user-specified values for the specified id.
W
- wrapToList(String, int) - Static method in class com.martiansoftware.util.StringUtils
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
BigDecimalStringParser.getParser()
or, even better,JSAP.BIGDECIMAL_PARSER
.