APIdia Launch Partner
Top Fields Constructors Methods
jdk.internal.joptsimple

public abstract Class AbstractOptionSpec<V>

extends Object
implements OptionSpec<V>, OptionDescriptor
Class Inheritance
All Implemented Interfaces
jdk.internal.joptsimple.OptionDescriptor, jdk.internal.joptsimple.OptionSpec
Known Direct Subclasses
jdk.internal.joptsimple.ArgumentAcceptingOptionSpec, jdk.internal.joptsimple.NoArgumentOptionSpec, jdk.internal.joptsimple.NonOptionArgumentSpec
Type Parameters
<V>
represents the type of the arguments this option accepts
Imports
java.util.ArrayList, .List, jdk.internal.joptsimple.internal.Reflection, .ReflectionException
Author
Paul Holser

Field Summary

Modifier and TypeField and Description
private final String
description

private boolean
forHelp

private final List<String>
options

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractOptionSpec(String option)

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

Method Summary

Modifier and TypeMethod 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 jdk.internal.joptsimple.OptionDescriptor.description.

Description of this option's purpose.

public boolean
equals(Object 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 this object.

public final boolean
isForHelp()

Implements jdk.internal.joptsimple.OptionSpec.isForHelp.

Tells whether this option is designated as a "help" option.

public final List<String>
options()

Implements jdk.internal.joptsimple.OptionSpec.options, jdk.internal.joptsimple.OptionDescriptor.options.

A set of options that are mutually synonymous.

public boolean
representsNonOptions()

Implements jdk.internal.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 detectedOptions)

Implements jdk.internal.joptsimple.OptionSpec.value.

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

public final List<V>
values(OptionSet detectedOptions)

Implements jdk.internal.joptsimple.OptionSpec.values.

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

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

descriptionback to summary
private final String description
forHelpback to summary
private boolean forHelp
optionsback to summary
private final List<String> options

Constructor Detail

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

Method Detail

argumentTypeIndicatorFromback to summary
protected String argumentTypeIndicatorFrom(ValueConverter<V> converter)
arrangeOptionsback to summary
private void arrangeOptions(List<String> unarranged)
convertback to summary
protected abstract V convert(String argument)
convertWithback to summary
protected V convertWith(ValueConverter<V> converter, String argument)
descriptionback to summary
public String description()

Implements jdk.internal.joptsimple.OptionDescriptor.description.

Doc from jdk.internal.joptsimple.OptionDescriptor.description.

Description of this option's purpose.

equalsback 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.

Annotations
@Override
forHelpback to summary
public final AbstractOptionSpec<V> forHelp()
handleOptionback to summary
pack-priv abstract void handleOption(OptionParser parser, ArgumentList arguments, OptionSet detectedOptions, String detectedArgument)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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.
Annotations
@Override
isForHelpback to summary
public final boolean isForHelp()

Implements jdk.internal.joptsimple.OptionSpec.isForHelp.

Doc from jdk.internal.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.

optionsback to summary
public final List<String> options()

Implements jdk.internal.joptsimple.OptionSpec.options, jdk.internal.joptsimple.OptionDescriptor.options.

Doc from jdk.internal.joptsimple.OptionDescriptor.options.

A set of options that are mutually synonymous.

representsNonOptionsback to summary
public boolean representsNonOptions()

Implements jdk.internal.joptsimple.OptionDescriptor.representsNonOptions.

Doc from jdk.internal.joptsimple.OptionDescriptor.representsNonOptions.

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

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
valueback to summary
public final V value(OptionSet detectedOptions)

Implements jdk.internal.joptsimple.OptionSpec.value.

Doc from jdk.internal.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.

valuesback to summary
public final List<V> values(OptionSet detectedOptions)

Implements jdk.internal.joptsimple.OptionSpec.values.

Doc from jdk.internal.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.