joptsimple

Class NoArgumentOptionSpec

java.lang.Object

joptsimple.AbstractOptionSpec<java.lang.Void>

joptsimple.NoArgumentOptionSpec

All Implemented Interfaces:

OptionDescriptor, OptionSpec<java.lang.Void>

Direct Known Subclasses:

OptionSpecBuilder

class NoArgumentOptionSpec
extends AbstractOptionSpec<java.lang.Void>

A specification for an option that does not accept arguments.

Constructor Summary

Constructors

Constructor and Description
NoArgumentOptionSpec(java.util.List<java.lang.String> options, java.lang.String description)
NoArgumentOptionSpec(java.lang.String option)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsArguments() Does this option accept arguments?
java.lang.String	argumentDescription() Gives a short description of the option's argument.
java.lang.String	argumentTypeIndicator() Gives an indication of the expected type of the option's argument.
protected java.lang.Void	convert(java.lang.String argument)
java.util.List<java.lang.Void>	defaultValues() What values will the option take if none are specified on the command line?
(package private) void	handleOption(OptionParser parser, ArgumentList arguments, OptionSet detectedOptions, java.lang.String detectedArgument)
boolean	isRequired() Is this option required on a command line?
boolean	requiresArgument() Does this option require an argument?

Methods inherited from class joptsimple.AbstractOptionSpec

argumentTypeIndicatorFrom, convertWith, description, equals, forHelp, hashCode, isForHelp, options, representsNonOptions, toString, value, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NoArgumentOptionSpec

NoArgumentOptionSpec(java.lang.String option)

NoArgumentOptionSpec

NoArgumentOptionSpec(java.util.List<java.lang.String> options,
                     java.lang.String description)

Method Detail

handleOption

void handleOption(OptionParser parser,
                  ArgumentList arguments,
                  OptionSet detectedOptions,
                  java.lang.String detectedArgument)

Specified by:

handleOption in class AbstractOptionSpec<java.lang.Void>

acceptsArguments

public boolean acceptsArguments()

Description copied from interface: OptionDescriptor

Does this option accept arguments?

Returns:

whether the option accepts arguments

requiresArgument

public boolean requiresArgument()

Description copied from interface: OptionDescriptor

Does this option require an argument?

Returns:

whether the option requires an argument

isRequired

public boolean isRequired()

Description copied from interface: OptionDescriptor

Is this option required on a command line?

Returns:

whether the option is required

argumentDescription

public java.lang.String argumentDescription()

Description copied from interface: OptionDescriptor

Gives a short description of the option's argument.

Returns:

a description for the option's argument

argumentTypeIndicator

public java.lang.String argumentTypeIndicator()

Description copied from interface: OptionDescriptor

Gives an indication of the expected type of the option's argument.

Returns:

a description for the option's argument type

convert

protected java.lang.Void convert(java.lang.String argument)

Specified by:

convert in class AbstractOptionSpec<java.lang.Void>

defaultValues

public java.util.List<java.lang.Void> defaultValues()

Description copied from interface: OptionDescriptor

What values will the option take if none are specified on the command line?

Returns:

any default values for the option