Module com.github.rvesse.airline

Package com.github.rvesse.airline.restrictions.options

Class RequiredUnlessEnvironmentRestriction

java.lang.Object

com.github.rvesse.airline.restrictions.AbstractCommonRestriction

com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction

com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction

All Implemented Interfaces:

HelpHint, ArgumentsRestriction, OptionRestriction

public class RequiredUnlessEnvironmentRestriction
extends AbstractRequiredUnlessRestriction
implements HelpHint

A restriction that requires an option/argument be set UNLESS a suitable environment variable is specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RequiredUnlessEnvironmentRestriction.IsEnvVarSet

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.String>	variables

Constructor Summary

Constructors

Constructor	Description
RequiredUnlessEnvironmentRestriction(java.lang.String[] envVars)

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
protected <T> boolean	unless(ParseState<T> state, ArgumentsMetadata arguments)	Answers whether the unless condition of the restriction is met
protected <T> boolean	unless(ParseState<T> state, OptionMetadata option)	Answers whether the unless condition of the restriction is met
protected java.lang.String	unlessDescription()	Provides a description of the unless condition, this will be included in the error messages when this restriction is not met

Methods inherited from class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction

finalValidate, finalValidate

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

variables

private final java.util.List<java.lang.String> variables

Constructor Detail

RequiredUnlessEnvironmentRestriction

public RequiredUnlessEnvironmentRestriction(java.lang.String[] envVars)

Method Detail

unless

protected <T> boolean unless(ParseState<T> state,
                             OptionMetadata option)

Description copied from class: AbstractRequiredUnlessRestriction

Answers whether the unless condition of the restriction is met

If the unless condition is met then the restriction will not require the option to be present.

Specified by:

unless in class AbstractRequiredUnlessRestriction

Type Parameters:

T - Command Type

Parameters:

state - Parse state

option - Option Metadata

Returns:

True if unless condition met, false otherwise

unless

protected <T> boolean unless(ParseState<T> state,
                             ArgumentsMetadata arguments)

Description copied from class: AbstractRequiredUnlessRestriction

Answers whether the unless condition of the restriction is met

If the unless condition is met then the restriction will not require arguments to be present.

Specified by:

unless in class AbstractRequiredUnlessRestriction

Type Parameters:

T - Command Type

Parameters:

state - Parse state

arguments - Arguments Metadata

Returns:

True if unless condition met, false otherwise

unlessDescription

protected java.lang.String unlessDescription()

Description copied from class: AbstractRequiredUnlessRestriction

Provides a description of the unless condition, this will be included in the error messages when this restriction is not met

Specified by:

unlessDescription in class AbstractRequiredUnlessRestriction

Returns:

Unless condition description

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