Module com.github.rvesse.airline

Package com.github.rvesse.airline.restrictions

Class AbstractCommonRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

All Implemented Interfaces:

ArgumentsRestriction, OptionRestriction

Direct Known Subclasses:

AbstractAllowedValuesRestriction, AbstractRequiredUnlessRestriction, AbstractStringRestriction, IsRequiredRestriction, MultipleOfRestriction, None, OccurrencesRestriction, PartialRestriction, PathRestriction, PatternRestriction, PortRestriction, PositiveNegativeRestriction, RangeRestriction

public abstract class AbstractCommonRestriction
extends java.lang.Object
implements OptionRestriction, ArgumentsRestriction

Constructor Summary

Constructors

Constructor	Description
AbstractCommonRestriction()

Method Summary

Modifier and Type	Method	Description
<T> void	finalValidate(ParseState<T> state, ArgumentsMetadata arguments)	Method that is called after Airline has completed parsing
<T> void	finalValidate(ParseState<T> state, OptionMetadata option)	Method that is called after Airline has completed parsing
static <T> java.lang.String	getArgumentTitle(ArgumentsMetadata arguments, int argIndex)
static <T> java.lang.String	getArgumentTitle(ParseState<T> state, ArgumentsMetadata arguments)
static <T> java.lang.String	getOptionTitle(ParseState<T> state, OptionMetadata option)
<T> void	postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)	Method that is called after Airline has converted a string argument received into a strongly typed Java value
<T> void	postValidate(ParseState<T> state, OptionMetadata option, java.lang.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, 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 value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCommonRestriction

public AbstractCommonRestriction()

Method Detail

finalValidate

public <T> void finalValidate(ParseState<T> state,
                              OptionMetadata option)

Description copied from interface: OptionRestriction

Method that is called after Airline has completed parsing

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

Specified by:

finalValidate in interface OptionRestriction

Parameters:

state - Parser state

option - Option meta-data

postValidate

public <T> void postValidate(ParseState<T> state,
                             OptionMetadata option,
                             java.lang.Object value)

Description copied from interface: OptionRestriction

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

Specified by:

postValidate in interface OptionRestriction

Parameters:

state - Parser state

option - Option meta-data

value - Strongly typed value

preValidate

public <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 interface OptionRestriction

Parameters:

state - Parser state

option - Option meta-data

value - String value

preValidate

public <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 interface ArgumentsRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

value - String value

postValidate

public <T> void postValidate(ParseState<T> state,
                             ArgumentsMetadata arguments,
                             java.lang.Object value)

Description copied from interface: ArgumentsRestriction

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

Specified by:

postValidate in interface ArgumentsRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

value - Strongly typed value

finalValidate

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

Description copied from interface: ArgumentsRestriction

Method that is called after Airline has completed parsing

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

Specified by:

finalValidate in interface ArgumentsRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

getOptionTitle

public static <T> java.lang.String getOptionTitle(ParseState<T> state,
                                                  OptionMetadata option)

getArgumentTitle

public static <T> java.lang.String getArgumentTitle(ParseState<T> state,
                                                    ArgumentsMetadata arguments)

getArgumentTitle

public static <T> java.lang.String getArgumentTitle(ArgumentsMetadata arguments,
                                                    int argIndex)