com.github.rvesse.airline.restrictions

Interface ArgumentsRestriction

All Known Implementing Classes:

AbstractAllowedValuesRestriction, AbstractCommonRestriction, AbstractLocaleAndCaseStringRestriction, AbstractStringRestriction, AllowedEnumValuesRestriction, AllowedRawValuesRestriction, AllowedValuesRestriction, EndsWithRestriction, IsRequiredRestriction, LengthRestriction, None, NoOptionLikeValuesRestriction, NotBlankRestriction, NotEmptyRestriction, OccurrencesRestriction, PartialRestriction, PathRestriction, PatternRestriction, PortRestriction, PositiveNegativeRestriction, RangeRestriction, StartsWithRestriction

public interface ArgumentsRestriction

Represents restrictions on arguments

Author:

rvesse

Method Summary

Modifier and Type	Method and Description
<T> void	finalValidate(ParseState<T> state, ArgumentsMetadata arguments) Method that is called after Airline has completed parsing
<T> void	postValidate(ParseState<T> state, ArgumentsMetadata arguments, Object value) Method that is called after Airline has converted a string argument received into a strongly typed Java value
<T> void	preValidate(ParseState<T> state, ArgumentsMetadata arguments, String value) Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value

Method Detail

preValidate

<T> void preValidate(ParseState<T> state,
                     ArgumentsMetadata arguments,
                     String value)

Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value

Parameters:

state - Parser state

arguments - Arguments meta-data

value - String value

postValidate

<T> void postValidate(ParseState<T> state,
                      ArgumentsMetadata arguments,
                      Object value)

Method that is called after Airline has converted a string argument received into a strongly typed Java value

Parameters:

state - Parser state

arguments - Arguments meta-data

value - Strongly typed value

finalValidate

<T> void finalValidate(ParseState<T> state,
                       ArgumentsMetadata arguments)

Method that is called after Airline has completed parsing

This can be used to implement restrictions that require the final parser state to process

Parameters:

state - Parser state

arguments - Arguments meta-data