Module com.github.rvesse.airline

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

Class NoOptionLikeValuesRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.common.AbstractStringRestriction

com.github.rvesse.airline.restrictions.common.AbstractLocaleAndCaseStringRestriction

com.github.rvesse.airline.restrictions.common.StartsWithRestriction

com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, GlobalRestriction, OptionRestriction

public class NoOptionLikeValuesRestriction
extends StartsWithRestriction
implements GlobalRestriction

A restriction that enforces that values CANNOT look like options

Please see NoOptionLikeValues for more discussion of how this restriction applies.

Field Summary

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

ignoreCase, locale

Fields inherited from interface com.github.rvesse.airline.restrictions.GlobalRestriction

DEFAULTS

Constructor Summary

Constructors

Constructor	Description
NoOptionLikeValuesRestriction(java.lang.String[] prefixes)

Method Summary

Modifier and Type	Method	Description
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
protected boolean	isValid(java.lang.String value)	Method that derived classes must implement to check whether a value is valid
int	numContentBlocks()	Gets the number of content blocks provided
<T> void	validate(ParseState<T> state)	Validates the parser state
protected <T> ParseRestrictionViolatedException	violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)	Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called if AbstractStringRestriction.isValid(String) returns false
protected <T> ParseRestrictionViolatedException	violated(ParseState<T> state, OptionMetadata option, java.lang.String value)	Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called if AbstractStringRestriction.isValid(String) returns false

Methods inherited from class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction

preValidate, preValidate

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

NoOptionLikeValuesRestriction

public NoOptionLikeValuesRestriction(java.lang.String[] prefixes)

Method Detail

isValid

protected boolean isValid(java.lang.String value)

Description copied from class: AbstractStringRestriction

Method that derived classes must implement to check whether a value is valid

Overrides:

isValid in class StartsWithRestriction

Parameters:

value - Value

Returns:

True if valid, false if valid

violated

protected <T> ParseRestrictionViolatedException violated(ParseState<T> state,
                                                         OptionMetadata option,
                                                         java.lang.String value)

Description copied from class: AbstractStringRestriction

Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called if AbstractStringRestriction.isValid(String) returns false

Overrides:

violated in class StartsWithRestriction

Parameters:

state - Parser state

option - Option metadata for the option whose value is being checked

value - Value which has been deemed invalid

Returns:

Exception

violated

protected <T> ParseRestrictionViolatedException violated(ParseState<T> state,
                                                         ArgumentsMetadata arguments,
                                                         java.lang.String value)

Description copied from class: AbstractStringRestriction

Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called if AbstractStringRestriction.isValid(String) returns false

Overrides:

violated in class StartsWithRestriction

Parameters:

state - Parser state

arguments - Arguments metadata

value - Value which has been deemed invalid

Returns:

Exception

validate

public <T> void validate(ParseState<T> state)

Description copied from interface: GlobalRestriction

Validates the parser state

Should throw an exception if the restriction is violated, otherwise should simply return

Specified by:

validate in interface GlobalRestriction

Parameters:

state - Parser state

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

Overrides:

getPreamble in class StartsWithRestriction

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

Overrides:

getFormat in class StartsWithRestriction

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

Overrides:

numContentBlocks in class StartsWithRestriction

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

Overrides:

getContentBlock in class StartsWithRestriction

Parameters:

blockNumber - Block number

Returns:

Content Block