com.github.rvesse.airline.restrictions.common

Class PortRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.common.PortRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class PortRestriction
extends AbstractCommonRestriction
implements HelpHint

Constructor Summary

Constructors

Constructor and Description
PortRestriction(PortRange... portRanges)

Method Summary

Modifier and Type	Method and 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
protected boolean	inAnyAcceptableRange(int port)
protected void	invalidArgumentsPort(ArgumentsMetadata arguments, String title, Object value)
protected void	invalidOptionPort(OptionMetadata option, String title, Object value)
protected void	invalidPort(String title, Object value)
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

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

Constructor Detail

PortRestriction

public PortRestriction(PortRange... portRanges)

Method Detail

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

invalidOptionPort

protected void invalidOptionPort(OptionMetadata option,
                                 String title,
                                 Object value)

invalidArgumentsPort

protected void invalidArgumentsPort(ArgumentsMetadata arguments,
                                    String title,
                                    Object value)

invalidPort

protected void invalidPort(String title,
                           Object 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

inAnyAcceptableRange

protected boolean inAnyAcceptableRange(int port)

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