APIdia Launch Partner
Top Description Methods
jdk.internal.joptsimple

public Interface OptionDescriptor

Known Direct Implementers
jdk.internal.joptsimple.AbstractOptionSpec
Imports
java.util.List
Describes options that an option parser recognizes, in ways that might be useful to help screens.
Author
Paul Holser

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

whether the option accepts arguments
acceptsArguments()

Does this option accept arguments?

public String

Returns:

a description for the option's argument
argumentDescription()

Gives a short description of the option's argument.

public String

Returns:

a description for the option's argument type
argumentTypeIndicator()

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

public List<?>

Returns:

any default values for the option
defaultValues()

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

public String

Returns:

a description for the option
description()

Description of this option's purpose.

public boolean

Returns:

whether the option is required
isRequired()

Is this option required on a command line?

public List<String>

Returns:

synonymous options
options()

A set of options that are mutually synonymous.

public boolean

Returns:

true if this represents non-option arguments
representsNonOptions()

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

public boolean

Returns:

whether the option requires an argument
requiresArgument()

Does this option require an argument?

Method Detail

acceptsArgumentsback to summary
public boolean acceptsArguments()

Does this option accept arguments?

Returns:boolean

whether the option accepts arguments

argumentDescriptionback to summary
public String argumentDescription()

Gives a short description of the option's argument.

Returns:String

a description for the option's argument

argumentTypeIndicatorback to summary
public String argumentTypeIndicator()

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

Returns:String

a description for the option's argument type

defaultValuesback to summary
public List<?> defaultValues()

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

Returns:List<?>

any default values for the option

descriptionback to summary
public String description()

Description of this option's purpose.

Returns:String

a description for the option

isRequiredback to summary
public boolean isRequired()

Is this option required on a command line?

Returns:boolean

whether the option is required

optionsback to summary
public List<String> options()

A set of options that are mutually synonymous.

Returns:List<String>

synonymous options

representsNonOptionsback to summary
public boolean representsNonOptions()

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

Returns:boolean

true if this represents non-option arguments

requiresArgumentback to summary
public boolean requiresArgument()

Does this option require an argument?

Returns:boolean

whether the option requires an argument