Module com.github.rvesse.airline

Package com.github.rvesse.airline.restrictions.common

Class AllowedValuesRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

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

com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class AllowedValuesRestriction
extends AbstractAllowedValuesRestriction

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.Object>	allowedValues
private java.lang.Object	currentState

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

CASE_INSENSITIVE, CASE_SENSITIVE, caseInsensitive, rawValues

Constructor Summary

Constructors

Constructor	Description
AllowedValuesRestriction(java.lang.String... rawValues)

Method Summary

Modifier and Type	Method	Description
protected <T> java.util.Set<java.lang.Object>	createAllowedValues(ParseState<T> state, java.lang.String title, java.lang.Class<?> type, TypeConverter converter)
<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

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, preValidate, preValidate

Methods inherited from class java.lang.Object

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

Field Detail

currentState

private java.lang.Object currentState

allowedValues

private java.util.Set<java.lang.Object> allowedValues

Constructor Detail

AllowedValuesRestriction

public AllowedValuesRestriction(java.lang.String... rawValues)

Method Detail

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

Overrides:

postValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

option - Option meta-data

value - Strongly typed value

createAllowedValues

protected <T> java.util.Set<java.lang.Object> createAllowedValues(ParseState<T> state,
                                                                  java.lang.String title,
                                                                  java.lang.Class<?> type,
                                                                  TypeConverter converter)

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

Overrides:

postValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

value - Strongly typed value