Module com.github.rvesse.airline.examples

Package com.github.rvesse.airline.examples.userguide.restrictions.custom

Class MultipleOfRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class MultipleOfRestriction
extends AbstractCommonRestriction
implements HelpHint

Field Summary

Fields

Modifier and Type	Field	Description
private int	multipleOf

Constructor Summary

Constructors

Constructor	Description
MultipleOfRestriction(int multipleOf)

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
int	numContentBlocks()	Gets the number of content blocks provided
<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
private <T> void	validate(ParseState<T> state, java.lang.String optionTitle, java.lang.Object value)

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

multipleOf

private final int multipleOf

Constructor Detail

MultipleOfRestriction

public MultipleOfRestriction(int multipleOf)

Method Detail

validate

private <T> void validate(ParseState<T> state,
                          java.lang.String optionTitle,
                          java.lang.Object value)

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

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

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