JOpt Simple 5.0.4 · joptsimple.AbstractOptionSpec

Modifier and Type	Field and Description
private final String	description
private boolean	forHelp
private final List<String>	options

Access	Constructor and Description
pack-priv	AbstractOptionSpec(String option)
pack-priv	AbstractOptionSpec(List<String> options, String description)

Method Summary

Modifier and Type	Method and Description
protected String	argumentTypeIndicatorFrom(ValueConverter<V> converter)
private void	arrangeOptions(List<String> unarranged)
protected abstract V	convert(String argument)
protected V	convertWith(ValueConverter<V> converter, String argument)
public String	description() Implements joptsimple.OptionDescriptor.description. Description of this option's purpose.
public boolean	equals(Object the reference object with which to compare. that) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final AbstractOptionSpec<V>	forHelp()
pack-priv abstract void	handleOption(OptionParser parser, ArgumentList arguments, OptionSet detectedOptions, String detectedArgument)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public final boolean	isForHelp() Implements joptsimple.OptionSpec.isForHelp. Tells whether this option is designated as a "help" option.
public final List<String>	options() Implements joptsimple.OptionSpec.options, joptsimple.OptionDescriptor.options. A set of options that are mutually synonymous.
public boolean	representsNonOptions() Implements joptsimple.OptionDescriptor.representsNonOptions. Tells whether this object represents the non-option arguments of a command line.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final V	value(OptionSet the detected options to search in detectedOptions) Implements joptsimple.OptionSpec.value. Gives the argument associated with the given option in the given set of detected options.
public final List<V>	values(OptionSet the detected options to search in detectedOptions) Implements joptsimple.OptionSpec.values. Gives any arguments associated with the given option in the given set of detected options.

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

description	back to summary
private final String description

forHelp	back to summary
private boolean forHelp

options	back to summary
private final List<String> options

AbstractOptionSpec	back to summary
pack-priv AbstractOptionSpec(String option)

AbstractOptionSpec	back to summary
pack-priv AbstractOptionSpec(List<String> options, String description)

Method Detail

argumentTypeIndicatorFrom	back to summary
protected String argumentTypeIndicatorFrom(ValueConverter<V> converter)

arrangeOptions	back to summary
private void arrangeOptions(List<String> unarranged)

convert	back to summary
protected abstract V convert(String argument)

convertWith	back to summary
protected V convertWith(ValueConverter<V> converter, String argument)

description	back to summary
public String description() Implements joptsimple.OptionDescriptor.description. Doc from joptsimple.OptionDescriptor.description. Description of this option's purpose. Returns:String a description for the option

description

back to summary

public String description()

Implements joptsimple.OptionDescriptor.description.

Doc from joptsimple.OptionDescriptor.description.

Description of this option's purpose.

Returns:String: a description for the option

equals back to summary

equals	back to summary
public boolean equals(Object that) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters that:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

that:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

forHelp	back to summary
public final AbstractOptionSpec<V> forHelp()

handleOption	back to summary
pack-priv abstract void handleOption(OptionParser parser, ArgumentList arguments, OptionSet detectedOptions, String detectedArgument)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isForHelp	back to summary
public final boolean isForHelp() Implements joptsimple.OptionSpec.isForHelp. Doc from joptsimple.OptionSpec.isForHelp. Tells whether this option is designated as a "help" option. The presence of a "help" option on a command line means that missing "required" options will not cause parsing to fail. Returns:boolean whether this option is designated as a "help" option

isForHelp

back to summary

public final boolean isForHelp()

Implements joptsimple.OptionSpec.isForHelp.

Doc from joptsimple.OptionSpec.isForHelp.

Tells whether this option is designated as a "help" option. The presence of a "help" option on a command line means that missing "required" options will not cause parsing to fail.

Returns:boolean: whether this option is designated as a "help" option

options	back to summary
public final List<String> options() Implements joptsimple.OptionSpec.options, joptsimple.OptionDescriptor.options. Doc from joptsimple.OptionDescriptor.options. A set of options that are mutually synonymous. Returns:List<String> Doc from joptsimple.OptionSpec.options. the string representations of this option

options

back to summary

public final List<String> options()

Implements joptsimple.OptionSpec.options, joptsimple.OptionDescriptor.options.

Doc from joptsimple.OptionDescriptor.options.

A set of options that are mutually synonymous.

Returns:List<String>

Doc from joptsimple.OptionSpec.options.

the string representations of this option

representsNonOptions back to summary

representsNonOptions	back to summary
public boolean representsNonOptions() Implements joptsimple.OptionDescriptor.representsNonOptions. Doc from joptsimple.OptionDescriptor.representsNonOptions. Tells whether this object represents the non-option arguments of a command line. Returns:boolean `true` if this represents non-option arguments

public boolean representsNonOptions()

Implements joptsimple.OptionDescriptor.representsNonOptions.

Doc from joptsimple.OptionDescriptor.representsNonOptions.

Tells whether this object represents the non-option arguments of a command line.

Returns:boolean: true if this represents non-option arguments

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

value back to summary

value	back to summary
public final V value(OptionSet detectedOptions) Implements joptsimple.OptionSpec.value. Doc from joptsimple.OptionSpec.value. Gives the argument associated with the given option in the given set of detected options. Specifying a default argument value for this option will cause this method to return that default value even if this option was not detected on the command line, or if this option can take an optional argument but did not have one on the command line. Parameters detectedOptions:OptionSet the detected options to search in Returns:V the argument of the this option; `null` if no argument is present, or that option was not detected

public final V value(OptionSet detectedOptions)

Implements joptsimple.OptionSpec.value.

Doc from joptsimple.OptionSpec.value.

Gives the argument associated with the given option in the given set of detected options.

Specifying a default argument value for this option will cause this method to return that default value even if this option was not detected on the command line, or if this option can take an optional argument but did not have one on the command line.

Parameters

detectedOptions:OptionSet: the detected options to search in

Returns:V

the argument of the this option; null if no argument is present, or that option was not detected

values	back to summary
public final List<V> values(OptionSet detectedOptions) Implements joptsimple.OptionSpec.values. Doc from joptsimple.OptionSpec.values. Gives any arguments associated with the given option in the given set of detected options. Specifying a default argument value for this option will cause this method to return that default value even if this option was not detected on the command line, or if this option can take an optional argument but did not have one on the command line. Parameters detectedOptions:OptionSet the detected options to search in Returns:List<V> the arguments associated with this option; an empty list if no such arguments are present, or if this option was not detected

values

back to summary

public final List<V> values(OptionSet detectedOptions)

Implements joptsimple.OptionSpec.values.

Doc from joptsimple.OptionSpec.values.

Gives any arguments associated with the given option in the given set of detected options.

Parameters

detectedOptions:OptionSet: the detected options to search in

Returns:List<V>

the arguments associated with this option; an empty list if no such arguments are present, or if this option was not detected

public abstract Class AbstractOptionSpec<V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail