com.github.rvesse.airline.restrictions.common

Class AllowedEnumValuesRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction

com.github.rvesse.airline.restrictions.common.AllowedEnumValuesRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class AllowedEnumValuesRestriction
extends AbstractAllowedValuesRestriction

Field Summary

Fields inherited from class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction

CASE_INSENSITIVE, CASE_SENSITIVE, caseInsensitive, rawValues

Constructor Summary

Constructors

Constructor and Description
AllowedEnumValuesRestriction(Class<? extends Enum<?>> cls)

Method Summary

Modifier and Type	Method and Description
<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
<T> void	preValidate(ParseState<T> state, OptionMetadata option, 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 com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction

asObjects, getAllowedValues, getContentBlock, getFormat, getPreamble, numContentBlocks

Methods inherited from class com.github.rvesse.airline.restrictions.AbstractCommonRestriction

finalValidate, finalValidate, getArgumentTitle, getArgumentTitle, getOptionTitle, postValidate, postValidate

Methods inherited from class java.lang.Object

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

Constructor Detail

AllowedEnumValuesRestriction

public AllowedEnumValuesRestriction(Class<? extends Enum<?>> cls)

Method Detail

preValidate

public <T> void preValidate(ParseState<T> state,
                            OptionMetadata option,
                            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

Overrides:

preValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

option - Option meta-data

value - String value

preValidate

public <T> void preValidate(ParseState<T> state,
                            ArgumentsMetadata arguments,
                            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

Overrides:

preValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

value - String value