Module com.github.rvesse.airline

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

Class AbstractAllowedValuesRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

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

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

Direct Known Subclasses:

AllowedEnumValuesRestriction, AllowedRawValuesRestriction, AllowedValuesRestriction

public abstract class AbstractAllowedValuesRestriction
extends AbstractCommonRestriction
implements HelpHint

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	CASE_INSENSITIVE
protected static boolean	CASE_SENSITIVE
protected boolean	caseInsensitive
protected java.util.Set<java.lang.String>	rawValues

Constructor Summary

Constructors

Constructor	Description
AbstractAllowedValuesRestriction(boolean caseInsensitive)

Method Summary

Modifier and Type	Method	Description
protected static java.util.Set<java.lang.Object>	asObjects(java.util.Set<java.lang.String> set)
java.util.Set<java.lang.String>	getAllowedValues()
java.lang.String[]	getContentBlock(int blockNumber)	Gets the content block with the given number
HelpFormat	getFormat()	Gets the format of the provided help information
java.lang.String	getPreamble()	Gets the preamble text that should be included
int	numContentBlocks()	Gets the number of content blocks provided

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CASE_SENSITIVE

protected static final boolean CASE_SENSITIVE

See Also:

Constant Field Values

CASE_INSENSITIVE

protected static final boolean CASE_INSENSITIVE

See Also:

Constant Field Values

rawValues

protected final java.util.Set<java.lang.String> rawValues

caseInsensitive

protected final boolean caseInsensitive

Constructor Detail

AbstractAllowedValuesRestriction

public AbstractAllowedValuesRestriction(boolean caseInsensitive)

Method Detail

asObjects

protected static java.util.Set<java.lang.Object> asObjects(java.util.Set<java.lang.String> set)

getPreamble

public java.lang.String getPreamble()

Description copied from interface: HelpHint

Gets the preamble text that should be included

Specified by:

getPreamble in interface HelpHint

Returns:

Preamble text

getFormat

public HelpFormat getFormat()

Description copied from interface: HelpHint

Gets the format of the provided help information

Specified by:

getFormat in interface HelpHint

Returns:

Help format

numContentBlocks

public int numContentBlocks()

Description copied from interface: HelpHint

Gets the number of content blocks provided

Help generators should consult the HelpHint.getFormat() return value to determine how to format the content blocks but they are not required to do so

Specified by:

numContentBlocks in interface HelpHint

Returns:

Number of content blocks

getContentBlock

public java.lang.String[] getContentBlock(int blockNumber)

Description copied from interface: HelpHint

Gets the content block with the given number

Specified by:

getContentBlock in interface HelpHint

Parameters:

blockNumber - Block number

Returns:

Content Block

getAllowedValues

public java.util.Set<java.lang.String> getAllowedValues()