joptsimple

Class AbstractOptionSpec<V>

java.lang.Object

joptsimple.AbstractOptionSpec<V>

Type Parameters:

V - represents the type of the arguments this option accepts

All Implemented Interfaces:

OptionDescriptor, OptionSpec<V>

Direct Known Subclasses:

ArgumentAcceptingOptionSpec, NonOptionArgumentSpec, OptionSpecBuilder

public abstract class AbstractOptionSpec<V>
extends Object
implements OptionSpec<V>, OptionDescriptor

Author:

Paul Holser

Method Summary

Modifier and Type	Method and Description
String	description() Description of this option's purpose.
boolean	equals(Object that)
AbstractOptionSpec<V>	forHelp()
int	hashCode()
boolean	isForHelp() Tells whether this option is designated as a "help" option.
List<String>	options() A set of options that are mutually synonymous.
boolean	representsNonOptions() Tells whether this object represents the non-option arguments of a command line.
String	toString()
V	value(OptionSet detectedOptions) Gives the argument associated with the given option in the given set of detected options.
Optional<V>	valueOptional(OptionSet detectedOptions) Gives the argument associated with the given option in the given set of detected options as an Optional.
List<V>	values(OptionSet detectedOptions) Gives any arguments associated with the given option in the given set of detected options.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface joptsimple.OptionDescriptor

acceptsArguments, argumentConverter, argumentDescription, argumentTypeIndicator, defaultValues, isRequired, requiresArgument

Method Detail

options

public final List<String> options()

Description copied from interface: OptionDescriptor

A set of options that are mutually synonymous.

Specified by:

options in interface OptionDescriptor

Specified by:

options in interface OptionSpec<V>

Returns:

the string representations of this option

values

public final List<V> values(OptionSet detectedOptions)

Description copied from interface: OptionSpec

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.

Specified by:

values in interface OptionSpec<V>

Parameters:

detectedOptions - the detected options to search in

Returns:

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

See Also:

OptionSet.valuesOf(OptionSpec)

value

public final V value(OptionSet detectedOptions)

Description copied from interface: OptionSpec

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.

Specified by:

value in interface OptionSpec<V>

Parameters:

detectedOptions - the detected options to search in

Returns:

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

See Also:

OptionSet.valueOf(OptionSpec)

valueOptional

public final Optional<V> valueOptional(OptionSet detectedOptions)

Description copied from interface: OptionSpec

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

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.

Specified by:

valueOptional in interface OptionSpec<V>

Parameters:

detectedOptions - the detected options to search in

Returns:

the argument of the this option as an Optional

See Also:

OptionSet.valueOf(OptionSpec)

description

public String description()

Description copied from interface: OptionDescriptor

Description of this option's purpose.

Specified by:

description in interface OptionDescriptor

Returns:

a description for the option

forHelp

public final AbstractOptionSpec<V> forHelp()

isForHelp

public final boolean isForHelp()

Description copied from interface: OptionSpec

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.

Specified by:

isForHelp in interface OptionSpec<V>

Returns:

whether this option is designated as a "help" option

representsNonOptions

public boolean representsNonOptions()

Description copied from interface: OptionDescriptor

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

Specified by:

representsNonOptions in interface OptionDescriptor

Returns:

true if this represents non-option arguments

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object