- 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(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.
- 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.
- 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.
- getDefaults(ExceptionMap) - Method in class com.martiansoftware.jsap.JSAP
-
Returns a Defaults object representing the merged Defaults of every
DefaultSource in the DefaultSource chain and the default values specified
in the AbstractParameters themselves.
- 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 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(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.
- 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
-
- getId() - Method in class com.martiansoftware.jsap.ant.ParameterConfiguration
-
Returns the unique ID for this parameter.
- getID() - Method in exception 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 com.martiansoftware.jsap.RequiredParameterMissingException
-
Returns the unique ID of the parameter that was missing.
- getID() - Method in exception 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(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.
- 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
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.BigIntegerStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.BooleanStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ByteStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.CharacterStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ClassStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ColorStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.DateStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.DoubleStringParser
-
- getParser(String, boolean, boolean) - Static method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Returns an EnumeratedParameterParser.
- getParser(String, boolean) - Static method in class com.martiansoftware.jsap.stringparsers.EnumeratedStringParser
-
Returns an EnumeratedParameterParser with parameter "checkOptionChars" set to true.
- 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() - Static method in class com.martiansoftware.jsap.stringparsers.FileStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.FloatStringParser
-
- getParser(Class) - Static method in class com.martiansoftware.jsap.stringparsers.ForNameStringParser
-
Returns a class forName()
string parser.
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.InetAddressStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.IntegerStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.IntSizeStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.LongSizeStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.LongStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.PackageStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.ShortStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.StringStringParser
-
- getParser() - Static method in class com.martiansoftware.jsap.stringparsers.URLStringParser
-
- 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.
- PACKAGE_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
- PackageStringParser - Class in com.martiansoftware.jsap.stringparsers
-
- PackageStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.PackageStringParser
-
- 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 array.
- parse(String) - Method in class com.martiansoftware.jsap.JSAP
-
Parses the specified command line.
- parse(String) - Method in class com.martiansoftware.jsap.Option
-
Parses the specified argument, returning the results in an ArrayList.
- parse(String) - Method in class com.martiansoftware.jsap.Parameter
-
Returns an ArrayList of values resulting from the parsing
of the specified argument.
- parse(String) - Method in class com.martiansoftware.jsap.SimpleJSAP
-
- 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.Switch
-
Creates a new BooleanStringParser to which it delegates the parsing of
the specified argument.
- ParseException - Exception in com.martiansoftware.jsap
-
A JSAPException subclass notifying the application of a parse error.
- ParseException() - Constructor for exception com.martiansoftware.jsap.ParseException
-
Creates a new ParseException.
- ParseException(String) - Constructor for exception com.martiansoftware.jsap.ParseException
-
Creates a new ParseException with the specified message.
- ParseException(Throwable) - Constructor for exception com.martiansoftware.jsap.ParseException
-
Creates a new ParseException encapsulating the specified Throwable.
- ParseException(String, Throwable) - Constructor for exception com.martiansoftware.jsap.ParseException
-
Creates a new ParseException with the specified message 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(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 in com.martiansoftware.jsap
-
A
StringParser
subclass that provides a means for setting/getting properties.
- PropertyStringParser() - Constructor for class com.martiansoftware.jsap.PropertyStringParser
-
- 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, 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.
- setDefaultIfNeeded(String, String) - Method in class com.martiansoftware.jsap.Defaults
-
Sets a single default value for the parameter with the specified ID if
and only if the specified parameter currently has no default values.
- setDefaultIfNeeded(String, String[]) - Method in class com.martiansoftware.jsap.Defaults
-
Sets an array of default values for the parameter with the specified ID
if and only if the specified parameter currently has no default values.
- 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.
- setLocked(boolean) - Method in class com.martiansoftware.jsap.Parameter
-
Locks or unlocks this parameter.
- 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
-
- setupStringParser(Option) - Method in class com.martiansoftware.jsap.ant.OptionConfiguration
-
Instantiates and configures A
StringParser
according to this
configuration, and provides it to the
specified Option.
- 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
-
- ShortStringParser - Class in com.martiansoftware.jsap.stringparsers
-
- ShortStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.ShortStringParser
-
- SimpleJSAP - Class in com.martiansoftware.jsap
-
A simple interface to
JSAP
that handles directly help,
explanation and an array of parameters.
- SimpleJSAP(String, String, Parameter[]) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with default screen width.
- SimpleJSAP(String, String) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with default screen width.
- SimpleJSAP(String) - Constructor for class com.martiansoftware.jsap.SimpleJSAP
-
Creates a new simple JSAP with a help switch, no explanation and default screen width.
- STRING_PARSER - Static variable in class com.martiansoftware.jsap.JSAP
-
- 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
-
- StringStringParser() - Constructor for class com.martiansoftware.jsap.stringparsers.StringStringParser
-
- 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.
- 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, String) - Constructor for class com.martiansoftware.jsap.Switch
-
A shortcut constructor that creates a new Switch and configures all of
its settings, including help.
- 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 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 in com.martiansoftware.jsap
-
An exception indicating that a syntax error was encountered in the argument
list.
- SyntaxException(String) - Constructor for exception com.martiansoftware.jsap.SyntaxException
-
Creates a new SyntaxException with the specified message.