com.lexicalscope.jewel.cli.specification

Interface ParsedOptionSpecification

All Superinterfaces:

OptionSpecification

public interface ParsedOptionSpecification
extends OptionSpecification

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowedValue(String value)
List<String>	getLongName() Get the long name of this option.
List<String>	getNames() All the names of the option
String	getPattern() The pattern that values must conform to
List<String>	getShortNames() Get all of the short names of this option.
boolean	hasShortName() Does this option have a Short Name
boolean	hasValue() Does the option take any arguments?
boolean	isBoolean()
boolean	isHelpOption() Is this option a request for help
void	reportMissingTo(ValidationErrorBuilder validationErrorBuilder)

Methods inherited from interface com.lexicalscope.jewel.cli.specification.OptionSpecification

allowedThisManyValues, compareCountToSpecification, exactly, getCanonicalIdentifier, getDefaultValue, getDescription, getMethod, getOptionalityMethod, getType, hasDefaultValue, hasExactCount, isHidden, isMultiValued, isOptional, maximum, maximumArgumentConsumption, minimum

Method Detail

getShortNames

List<String> getShortNames()

Get all of the short names of this option. Short names are single characters that will by prefixed by the user with "-".

Returns:

the short names of this option

getNames

List<String> getNames()

All the names of the option

Returns:

all the names of the option

hasShortName

boolean hasShortName()

Does this option have a Short Name

Returns:

true iff the options has a short name

getLongName

List<String> getLongName()

Get the long name of this option. Long names are multiple characters that will be prefixed by the user with "--".

Returns:

the long name of this option

getPattern

String getPattern()

The pattern that values must conform to

Returns:

the regular expression that values must conform to

allowedValue

boolean allowedValue(String value)

hasValue

boolean hasValue()

Does the option take any arguments?

Specified by:

hasValue in interface OptionSpecification

Returns:

True iff the the option takes at least one argument

isHelpOption

boolean isHelpOption()

Is this option a request for help

Returns:

True iff this option is a request for help

isBoolean

boolean isBoolean()

Returns:

option is a boolean option

reportMissingTo

void reportMissingTo(ValidationErrorBuilder validationErrorBuilder)