Module com.github.rvesse.airline
Class AbstractStringRestriction
- java.lang.Object
-
- com.github.rvesse.airline.restrictions.AbstractCommonRestriction
-
- com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
-
- All Implemented Interfaces:
ArgumentsRestriction
,OptionRestriction
- Direct Known Subclasses:
AbstractLocaleAndCaseStringRestriction
,LengthRestriction
,NotBlankRestriction
,NotEmptyRestriction
public abstract class AbstractStringRestriction extends AbstractCommonRestriction
Abstract restrictions on string values for options and arguments
-
-
Constructor Summary
Constructors Constructor Description AbstractStringRestriction()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract boolean
isValid(java.lang.String value)
Method that derived classes must implement to check whether a value is valid<T> void
preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value<T> void
preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java valueprotected abstract <T> ParseRestrictionViolatedException
violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called ifisValid(String)
returnsfalse
protected abstract <T> ParseRestrictionViolatedException
violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called ifisValid(String)
returnsfalse
-
Methods inherited from class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
finalValidate, finalValidate, getArgumentTitle, getArgumentTitle, getOptionTitle, postValidate, postValidate
-
-
-
-
Method Detail
-
preValidate
public final <T> void preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
Description copied from interface:OptionRestriction
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value- Specified by:
preValidate
in interfaceOptionRestriction
- Overrides:
preValidate
in classAbstractCommonRestriction
- Parameters:
state
- Parser stateoption
- Option meta-datavalue
- String value
-
preValidate
public final <T> void preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
Description copied from interface:ArgumentsRestriction
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value- Specified by:
preValidate
in interfaceArgumentsRestriction
- Overrides:
preValidate
in classAbstractCommonRestriction
- Parameters:
state
- Parser statearguments
- Arguments meta-datavalue
- String value
-
isValid
protected abstract boolean isValid(java.lang.String value)
Method that derived classes must implement to check whether a value is valid- Parameters:
value
- Value- Returns:
- True if valid, false if valid
-
violated
protected abstract <T> ParseRestrictionViolatedException violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called ifisValid(String)
returnsfalse
- Parameters:
state
- Parser stateoption
- Option metadata for the option whose value is being checkedvalue
- Value which has been deemed invalid- Returns:
- Exception
-
violated
protected abstract <T> ParseRestrictionViolatedException violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called ifisValid(String)
returnsfalse
- Parameters:
state
- Parser statearguments
- Arguments metadatavalue
- Value which has been deemed invalid- Returns:
- Exception
-
-