Uses of Interface
com.github.rvesse.airline.restrictions.OptionRestriction

Packages that use OptionRestriction

Package	Description
com.github.rvesse.airline.examples.userguide.restrictions.custom
com.github.rvesse.airline.help.cli
com.github.rvesse.airline.help.common
com.github.rvesse.airline.help.html
com.github.rvesse.airline.help.man
com.github.rvesse.airline.help.markdown
com.github.rvesse.airline.model
com.github.rvesse.airline.restrictions
com.github.rvesse.airline.restrictions.common
com.github.rvesse.airline.restrictions.factories
com.github.rvesse.airline.restrictions.options
com.github.rvesse.airline.utils.predicates.restrictions

Uses of OptionRestriction in com.github.rvesse.airline.examples.userguide.restrictions.custom

Classes in com.github.rvesse.airline.examples.userguide.restrictions.custom that implement OptionRestriction

Modifier and Type	Class	Description
class	MultipleOfRestriction

Methods in com.github.rvesse.airline.examples.userguide.restrictions.custom that return OptionRestriction

Modifier and Type	Method	Description
OptionRestriction	MultipleRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)

Uses of OptionRestriction in com.github.rvesse.airline.help.cli

Methods in com.github.rvesse.airline.help.cli with parameters of type OptionRestriction

Modifier and Type	Method	Description
protected void	CliUsageHelper.outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option

Uses of OptionRestriction in com.github.rvesse.airline.help.common

Method parameters in com.github.rvesse.airline.help.common with type arguments of type OptionRestriction

Modifier and Type	Method	Description
protected java.util.List<HelpHint>	AbstractUsageGenerator.sortOptionRestrictions(java.util.List<OptionRestriction> restrictions)

Uses of OptionRestriction in com.github.rvesse.airline.help.html

Methods in com.github.rvesse.airline.help.html with parameters of type OptionRestriction

Modifier and Type	Method	Description
protected void	HtmlCommandUsageGenerator.outputOptionRestriction(java.io.Writer writer, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs a documentation section detailing an allowed value for an option

Uses of OptionRestriction in com.github.rvesse.airline.help.man

Methods in com.github.rvesse.airline.help.man with parameters of type OptionRestriction

Modifier and Type	Method	Description
protected void	ManUsageHelper.outputOptionRestriction(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option

Uses of OptionRestriction in com.github.rvesse.airline.help.markdown

Methods in com.github.rvesse.airline.help.markdown with parameters of type OptionRestriction

Modifier and Type	Method	Description
protected void	MarkdownUsageHelper.outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option

Uses of OptionRestriction in com.github.rvesse.airline.model

Fields in com.github.rvesse.airline.model with type parameters of type OptionRestriction

Modifier and Type	Field	Description
private java.util.List<OptionRestriction>	OptionMetadata.restrictions

Methods in com.github.rvesse.airline.model that return types with arguments of type OptionRestriction

Modifier and Type	Method	Description
java.util.List<OptionRestriction>	OptionMetadata.getRestrictions()

Uses of OptionRestriction in com.github.rvesse.airline.restrictions

Classes in com.github.rvesse.airline.restrictions that implement OptionRestriction

Modifier and Type	Class	Description
class	AbstractCommonRestriction
class	None	A restriction which doesn't actually impose any restrictions

Uses of OptionRestriction in com.github.rvesse.airline.restrictions.common

Classes in com.github.rvesse.airline.restrictions.common that implement OptionRestriction

Modifier and Type	Class	Description
class	AbstractAllowedValuesRestriction
class	AbstractLocaleAndCaseStringRestriction	An abstract string restriction that needs a locale and case sensitivity flag
class	AbstractStringRestriction	Abstract restrictions on string values for options and arguments
class	AllowedEnumValuesRestriction
class	AllowedRawValuesRestriction
class	AllowedValuesRestriction
class	EndsWithRestriction	A restriction that requires raw values to end with one of a set of suffixes
class	IsRequiredRestriction	A restriction that options/arguments are required
class	LengthRestriction	A restriction that requires string values meet length constraints
class	NoOptionLikeValuesRestriction	A restriction that enforces that values CANNOT look like options
class	NotBlankRestriction
class	NotEmptyRestriction
class	OccurrencesRestriction
class	PartialRestriction
class	PathRestriction	Implements restriction on options and arguments that expect to receive a path to a file and/or directory
class	PatternRestriction	A restriction which requires the raw values to match a given regular expression
class	PortRestriction
class	PositiveNegativeRestriction	Restriction that enforces that values must be either positive/negative with zero optionally included
class	RangeRestriction	A restriction that requires the value (after type conversion) to be within a given range
class	StartsWithRestriction	A restriction that requires raw values to start with one of a set of prefixes

Fields in com.github.rvesse.airline.restrictions.common declared as OptionRestriction

Modifier and Type	Field	Description
private OptionRestriction	PartialRestriction.optionRestriction

Constructors in com.github.rvesse.airline.restrictions.common with parameters of type OptionRestriction

Constructor	Description
PartialRestriction(int[] indices, OptionRestriction optionRestriction)
PartialRestriction(OptionRestriction optionRestriction)
PartialRestriction(java.util.Collection<java.lang.Integer> indices, OptionRestriction optionRestriction)

Uses of OptionRestriction in com.github.rvesse.airline.restrictions.factories

Methods in com.github.rvesse.airline.restrictions.factories that return OptionRestriction

Modifier and Type	Method	Description
OptionRestriction	AllowedValuesRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	OccurrencesRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	OptionRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)	Try and create an option restriction from the given annotation
OptionRestriction	PathRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	PortRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	RangeRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	RequiredOnlyIfRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	RequireFromRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	SimpleRestrictionsFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
OptionRestriction	StringRestrictionFactory.createOptionRestriction(java.lang.annotation.Annotation annotation)
static <T extends java.lang.annotation.Annotation> OptionRestriction	RestrictionRegistry.getOptionRestriction(java.lang.Class<? extends java.lang.annotation.Annotation> cls, T annotation)

Uses of OptionRestriction in com.github.rvesse.airline.restrictions.options

Classes in com.github.rvesse.airline.restrictions.options that implement OptionRestriction

Modifier and Type	Class	Description
class	AbstractRequiredUnlessRestriction	A restriction that options/arguments are required unless some other criteria is met
class	MutuallyExclusiveRestriction
class	RequiredOnlyIfRestriction
class	RequiredUnlessEnvironmentRestriction	A restriction that requires an option/argument be set UNLESS a suitable environment variable is specified.
class	RequireFromRestriction

Uses of OptionRestriction in com.github.rvesse.airline.utils.predicates.restrictions

Methods in com.github.rvesse.airline.utils.predicates.restrictions that return types with arguments of type OptionRestriction

Modifier and Type	Method	Description
protected abstract org.apache.commons.collections4.Predicate<OptionRestriction>	AbstractOptionRestrictionBasedFinder.getRestrictionPredicate()
protected abstract org.apache.commons.collections4.Predicate<OptionRestriction>	AbstractParsedOptionRestrictionBasedFinder.getRestrictionPredicate()
protected org.apache.commons.collections4.Predicate<OptionRestriction>	MutuallyExclusiveWithOptionFinder.getRestrictionPredicate()
protected org.apache.commons.collections4.Predicate<OptionRestriction>	MutuallyExclusiveWithTagParsedOptionFinder.getRestrictionPredicate()
protected org.apache.commons.collections4.Predicate<OptionRestriction>	RequiredTagOptionFinder.getRestrictionPredicate()
protected org.apache.commons.collections4.Predicate<OptionRestriction>	RequiredTagParsedOptionFinder.getRestrictionPredicate()

Methods in com.github.rvesse.airline.utils.predicates.restrictions with parameters of type OptionRestriction

Modifier and Type	Method	Description
boolean	AllowedValuesOptionFinder.evaluate(OptionRestriction restriction)
boolean	IsRequiredOptionFinder.evaluate(OptionRestriction restriction)
boolean	MutuallyExclusiveWithFinder.evaluate(OptionRestriction restriction)
boolean	RequiredFromFinder.evaluate(OptionRestriction restriction)