Module com.github.rvesse.airline

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

Class LengthRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

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

com.github.rvesse.airline.restrictions.common.LengthRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class LengthRestriction
extends AbstractStringRestriction
implements HelpHint

A restriction that requires string values meet length constraints

Field Summary

Fields

Modifier and Type	Field	Description
private int	max
private boolean	maximum
private int	min
private boolean	range

Constructor Summary

Constructors

Constructor	Description
LengthRestriction(int length, boolean maximum)	Creates a length restriction with either a minimum or maximum
LengthRestriction(int min, int max)	Creates a length restriction with a minimum and maximum i.e.

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

Field Detail

maximum

private final boolean maximum

range

private final boolean range

min

private final int min

max

private final int max

Constructor Detail

LengthRestriction

public LengthRestriction(int length,
                         boolean maximum)

Creates a length restriction with either a minimum or maximum

Parameters:

length - Length

maximum - True if the length is a maximum, false if it is a minimum

LengthRestriction

public LengthRestriction(int min,
                         int max)

Creates a length restriction with a minimum and maximum i.e. a range

Parameters:

min - Minimum length

max - Maximum length

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

Specified by:

isValid in class AbstractStringRestriction

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

Specified by:

violated in class AbstractStringRestriction

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

Specified by:

violated in class AbstractStringRestriction

Parameters:

state - Parser state

arguments - Arguments metadata

value - Value which has been deemed invalid

Returns:

Exception

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