joptsimple

Class OptionSet

java.lang.Object

joptsimple.OptionSet

public class OptionSet
extends Object

Representation of a group of detected command line options, their arguments, and non-option arguments.

Author:

Paul Holser

Method Summary

Modifier and Type	Method and Description
Map<OptionSpec<?>,List<?>>	asMap() Gives all declared options as a map of string to OptionSpec.
boolean	equals(Object that)
boolean	has(OptionSpec<?> option) Tells whether the given option was detected.
boolean	has(String option) Tells whether the given option was detected.
boolean	hasArgument(OptionSpec<?> option) Tells whether there are any arguments associated with the given option.
boolean	hasArgument(String option) Tells whether there are any arguments associated with the given option.
int	hashCode()
boolean	hasOptions() Tells whether any options were detected.
List<?>	nonOptionArguments()
List<OptionSpec<?>>	specs() Gives the set of options that were detected, in the form of OptionSpecs, in the order in which the options were found on the command line.
<V> V	valueOf(OptionSpec<V> option) Gives the argument associated with the given option.
Object	valueOf(String option) Gives the argument associated with the given option.
<V> Optional<V>	valueOfOptional(OptionSpec<V> option) Gives the argument associated with the given option as an Optional.
Optional<Object>	valueOfOptional(String option) Gives the argument associated with the given option, as an Optional.
<V> List<V>	valuesOf(OptionSpec<V> option) Gives any arguments associated with the given option.
List<?>	valuesOf(String option) Gives any arguments associated with the given option.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasOptions

public boolean hasOptions()

Tells whether any options were detected.

Returns:

true if any options were detected

has

public boolean has(String option)

Tells whether the given option was detected.

Parameters:

option - the option to search for

Returns:

true if the option was detected

See Also:

has(OptionSpec)

has

public boolean has(OptionSpec<?> option)

Tells whether the given option was detected.

This method recognizes only instances of options returned from the fluent interface methods.

Specifying a ArgumentAcceptingOptionSpec.defaultsTo(Object, Object[]) default argument value} for an option does not cause this method to return true if the option was not detected on the command line.

Parameters:

option - the option to search for

Returns:

true if the option was detected

See Also:

has(String)

hasArgument

public boolean hasArgument(String option)

Tells whether there are any arguments associated with the given option.

Parameters:

option - the option to search for

Returns:

true if the option was detected and at least one argument was detected for the option

See Also:

hasArgument(OptionSpec)

hasArgument

public boolean hasArgument(OptionSpec<?> option)

Tells whether there are any arguments associated with the given option.

This method recognizes only instances of options returned from the fluent interface methods.

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

Parameters:

option - the option to search for

Returns:

true if the option was detected and at least one argument was detected for the option

Throws:

NullPointerException - if option is null

See Also:

hasArgument(String)

valueOf

public Object valueOf(String option)

Gives the argument associated with the given option. If the option was given an argument type, the argument will take on that type; otherwise, it will be a String.

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

Parameters:

option - the option to search for

Returns:

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

Throws:

NullPointerException - if option is null

OptionException - if more than one argument was detected for the option

valueOfOptional

public Optional<Object> valueOfOptional(String option)

Gives the argument associated with the given option, as an Optional. If the option was given an argument type, the argument will take on that type; otherwise, it will be a String.

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

Parameters:

option - the option to search for

Returns:

the argument of the given option as an Optional

Throws:

NullPointerException - if option is null

OptionException - if more than one argument was detected for the option

valueOf

public <V> V valueOf(OptionSpec<V> option)

Gives the argument associated with the given option.

This method recognizes only instances of options returned from the fluent interface methods.

Type Parameters:

V - represents the type of the arguments the given option accepts

Parameters:

option - the option to search for

Returns:

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

Throws:

OptionException - if more than one argument was detected for the option

NullPointerException - if option is null

ClassCastException - if the arguments of this option are not of the expected type

valueOfOptional

public <V> Optional<V> valueOfOptional(OptionSpec<V> option)

Gives the argument associated with the given option as an Optional.

This method recognizes only instances of options returned from the fluent interface methods.

Type Parameters:

V - represents the type of the arguments the given option accepts

Parameters:

option - the option to search for

Returns:

the argument of the given option as an Optional

Throws:

OptionException - if more than one argument was detected for the option

NullPointerException - if option is null

ClassCastException - if the arguments of this option are not of the expected type

valuesOf

public List<?> valuesOf(String option)

Gives any arguments associated with the given option. If the option was given an argument type, the arguments will take on that type; otherwise, they will be Strings.

Parameters:

option - the option to search for

Returns:

the arguments associated with the option, as a list of objects of the type given to the arguments; an empty list if no such arguments are present, or if the option was not detected

Throws:

NullPointerException - if option is null

valuesOf

public <V> List<V> valuesOf(OptionSpec<V> option)

Gives any arguments associated with the given option. If the option was given an argument type, the arguments will take on that type; otherwise, they will be Strings.

This method recognizes only instances of options returned from the fluent interface methods.

Type Parameters:

V - represents the type of the arguments the given option accepts

Parameters:

option - the option to search for

Returns:

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

Throws:

NullPointerException - if option is null

OptionException - if there is a problem converting the option's arguments to the desired type; for example, if the type does not implement a correct conversion constructor or method

specs

public List<OptionSpec<?>> specs()

Gives the set of options that were detected, in the form of OptionSpecs, in the order in which the options were found on the command line.

Returns:

the set of detected command line options

asMap

public Map<OptionSpec<?>,List<?>> asMap()

Gives all declared options as a map of string to OptionSpec.

Returns:

the declared options as a map

nonOptionArguments

public List<?> nonOptionArguments()

Returns:

the detected non-option arguments

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object