Module com.github.rvesse.airline

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

Class OccurrencesRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.common.OccurrencesRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class OccurrencesRestriction
extends AbstractCommonRestriction
implements HelpHint

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	maximum
private int	occurrences

Constructor Summary

Constructors

Constructor	Description
OccurrencesRestriction(int occurrences, boolean maximum)

Method Summary

Modifier and Type	Method	Description
<T> void	finalValidate(ParseState<T> state, ArgumentsMetadata arguments)	Method that is called after Airline has completed parsing
<T> void	finalValidate(ParseState<T> state, OptionMetadata option)	Method that is called after Airline has completed parsing
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
private <T> java.util.List<java.lang.String>	titles(ParseState<T> state, ArgumentsMetadata arguments)

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

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

occurrences

private final int occurrences

maximum

private final boolean maximum

Constructor Detail

OccurrencesRestriction

public OccurrencesRestriction(int occurrences,
                              boolean maximum)

Method Detail

finalValidate

public <T> void finalValidate(ParseState<T> state,
                              OptionMetadata option)

Description copied from interface: OptionRestriction

Method that is called after Airline has completed parsing

This can be used to implement restrictions that require the final parser state to process

Specified by:

finalValidate in interface OptionRestriction

Overrides:

finalValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

option - Option meta-data

finalValidate

public <T> void finalValidate(ParseState<T> state,
                              ArgumentsMetadata arguments)

Description copied from interface: ArgumentsRestriction

Method that is called after Airline has completed parsing

This can be used to implement restrictions that require the final parser state to process

Specified by:

finalValidate in interface ArgumentsRestriction

Overrides:

finalValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

titles

private <T> java.util.List<java.lang.String> titles(ParseState<T> state,
                                                    ArgumentsMetadata arguments)

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