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 AbstractAllowedValuesRestriction

CASE_INSENSITIVE, CASE_SENSITIVE, caseInsensitive, rawValues

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private Collection<String>	getValues(Class<? extends Enum<?>> cls)
<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 AbstractAllowedValuesRestriction

asObjects, getAllowedValues, getContentBlock, getFormat, getPreamble, numContentBlocks

Methods inherited from class AbstractCommonRestriction

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

Methods inherited from class Object

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

Constructor Details

AllowedEnumValuesRestriction

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

Method Details

getValues

private Collection<String> getValues(Class<? extends Enum<?>> cls)

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