com.lexicalscope.jewel.cli.specification

Interface OptionSpecification

All Known Subinterfaces:

ParsedOptionSpecification, UnparsedOptionSpecification

public interface OptionSpecification

Specifies an Option BETA: unstable may change in future versions

Author:

t.wood

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowedThisManyValues(int count) Is the option allowed to have this many values?
<T> T	compareCountToSpecification(int valueCount, SpecificationMultiplicity<T> specificationMultiplicity)
int	exactly()
String	getCanonicalIdentifier() Canonical identifier for the option
List<String>	getDefaultValue() Get the default values which will be used if the option is not specified by the user.
String	getDescription() Get a description of the option.
com.lexicalscope.fluentreflection.FluentMethod	getMethod()
com.lexicalscope.fluentreflection.FluentMethod	getOptionalityMethod()
Class<?>	getType() Each argument to this option must conform to the type returned by this method
boolean	hasDefaultValue() Is there a default value to use if this option is not present? Options with a default value are assumed to be optional.
boolean	hasExactCount()
boolean	hasValue() Does the option have a value
boolean	isHidden() Is the option hidden from help messages?
boolean	isMultiValued() Are multiple arguments allowed?
boolean	isOptional() Is the argument optional
int	maximum()
int	maximumArgumentConsumption()
int	minimum()

Method Detail

getDescription

String getDescription()

Get a description of the option. The description can be specified in the Option annotation

Returns:

a description of the option

See Also:

Option

getType

Class<?> getType()

Each argument to this option must conform to the type returned by this method

Returns:

the type that each argument must conform to

getCanonicalIdentifier

String getCanonicalIdentifier()

Canonical identifier for the option

Returns:

the canonical identifier for the option

isMultiValued

boolean isMultiValued()

Are multiple arguments allowed?

Returns:

True iff the the option takes multiple arguments

hasValue

boolean hasValue()

Does the option have a value

Returns:

true iff the option has at least one value

isOptional

boolean isOptional()

Is the argument optional

Returns:

is the argument optional

getDefaultValue

List<String> getDefaultValue()

Get the default values which will be used if the option is not specified by the user.

Returns:

The default values which will be used if the option is not present

hasDefaultValue

boolean hasDefaultValue()

Is there a default value to use if this option is not present? Options with a default value are assumed to be optional.

Returns:

true iff this option has a default value

isHidden

boolean isHidden()

Is the option hidden from help messages?

Returns:

true iff the option is hidden from help messages

allowedThisManyValues

boolean allowedThisManyValues(int count)

Is the option allowed to have this many values?

Parameters:

count - the number of values that the option might have

Returns:

true iff the count is a valid number of values for this option

getMethod

com.lexicalscope.fluentreflection.FluentMethod getMethod()

getOptionalityMethod

com.lexicalscope.fluentreflection.FluentMethod getOptionalityMethod()

hasExactCount

boolean hasExactCount()

exactly

int exactly()

minimum

int minimum()

maximum

int maximum()

maximumArgumentConsumption

int maximumArgumentConsumption()

compareCountToSpecification

<T> T compareCountToSpecification(int valueCount,
                                SpecificationMultiplicity<T> specificationMultiplicity)