Class PartialRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.common.PartialRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class PartialRestriction
extends AbstractCommonRestriction
implements HelpHint

Field Summary

Fields

Modifier and Type	Field	Description
private final ArgumentsRestriction	argumentsRestriction
private final HelpHint	hint
private final Set<Integer>	indices
private final OptionRestriction	optionRestriction

Constructor Summary

Constructors

Modifier	Constructor	Description
	PartialRestriction(int[] indices, ArgumentsRestriction argumentsRestriction)
	PartialRestriction(int[] indices, OptionRestriction optionRestriction)
private	PartialRestriction(ArgumentsRestriction argumentsRestriction)
private	PartialRestriction(OptionRestriction optionRestriction)
	PartialRestriction(Collection<Integer> indices, ArgumentsRestriction argumentsRestriction)
	PartialRestriction(Collection<Integer> indices, OptionRestriction optionRestriction)

Method Summary

Modifier and Type	Method	Description
String[]	getContentBlock(int blockNumber)	Gets the content block with the given number
HelpFormat	getFormat()	Gets the format of the provided help information
String	getPreamble()	Gets the preamble text that should be included
private <T> boolean	isApplicableToArgument(ParseState<T> state)
private <T> boolean	isApplicableToOption(ParseState<T> state, OptionMetadata option)
int	numContentBlocks()	Gets the number of content blocks provided
<T> void	postValidate(ParseState<T> state, ArgumentsMetadata arguments, 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, Object value)	Method that is called after Airline has converted a string argument received into a strongly typed Java value
<T> void	preValidate(ParseState<T> state, ArgumentsMetadata arguments, String value)	Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value
<T> void	preValidate(ParseState<T> state, OptionMetadata option, String value)	Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value

Methods inherited from class AbstractCommonRestriction

finalValidate, finalValidate, getArgumentTitle, getArgumentTitle, getOptionTitle

Methods inherited from class Object

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

Field Details

indices

private final Set<Integer> indices

optionRestriction

private final OptionRestriction optionRestriction

argumentsRestriction

private final ArgumentsRestriction argumentsRestriction

hint

private final HelpHint hint

Constructor Details

PartialRestriction

private PartialRestriction(OptionRestriction optionRestriction)

PartialRestriction

private PartialRestriction(ArgumentsRestriction argumentsRestriction)

PartialRestriction

public PartialRestriction(int[] indices,
 OptionRestriction optionRestriction)

PartialRestriction

public PartialRestriction(int[] indices,
 ArgumentsRestriction argumentsRestriction)

PartialRestriction

public PartialRestriction(Collection<Integer> indices,
 OptionRestriction optionRestriction)

PartialRestriction

public PartialRestriction(Collection<Integer> indices,
 ArgumentsRestriction argumentsRestriction)

Method Details

isApplicableToOption

private <T> boolean isApplicableToOption(ParseState<T> state,
 OptionMetadata option)

preValidate

public <T> void preValidate(ParseState<T> state,
 OptionMetadata option,
 String value)

Description copied from interface: OptionRestriction

Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value

Specified by:

preValidate in interface OptionRestriction

Overrides:

preValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

option - Option meta-data

value - String value

postValidate

public <T> void postValidate(ParseState<T> state,
 OptionMetadata option,
 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

isApplicableToArgument

private <T> boolean isApplicableToArgument(ParseState<T> state)

preValidate

public <T> void preValidate(ParseState<T> state,
 ArgumentsMetadata arguments,
 String value)

Description copied from interface: ArgumentsRestriction

Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value

Specified by:

preValidate in interface ArgumentsRestriction

Overrides:

preValidate in class AbstractCommonRestriction

Parameters:

state - Parser state

arguments - Arguments meta-data

value - String value

postValidate

public <T> void postValidate(ParseState<T> state,
 ArgumentsMetadata arguments,
 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 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 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