de.vandermeer.skb.interfaces.application

Interface ApoBaseC

All Superinterfaces:

ApoBase, CategoryHas, CategoryIs, HasDescription

All Known Subinterfaces:

Apo_SimpleC, Apo_TypedC<T>, Apo_TypedCE<T>, Apo_TypedCP<T>, Apo_TypedCPE<T>

public interface ApoBaseC
extends ApoBase

Base for a CLI option.

Since:

v0.0.2

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
boolean	cliIsRequired() Tests if the CLI option is required meaning it must be used in the command line.
String	getCliLong() Returns the long CLI option.
Character	getCliShort() Returns the short CLI option.
default String	getCliShortLong() Returns a CLI option either short or long.
default ST	getHelp() Returns help information for the option.
boolean	inCli() Tests if the option was present in a parsed command line.
void	setInCLi(boolean inCli) Sets the option flag for being in a command line.
default void	validate() Validates the option.

Methods inherited from interface ApoBase

getDisplayName, getLongDescription, isSet

Methods inherited from interface HasDescription

getDescription

Method Detail

cliIsRequired

boolean cliIsRequired()

Tests if the CLI option is required meaning it must be used in the command line.

Returns:

true if required, false otherwise

getCliLong

String getCliLong()

Returns the long CLI option.

Returns:

long CLI option, must not be blank

getCliShort

Character getCliShort()

Returns the short CLI option.

Returns:

short CLI option, null if none set

getCliShortLong

default String getCliShortLong()

Returns a CLI option either short or long.

Returns:

CLI option, short if short is not null, long otherwise

getHelp

default ST getHelp()

Description copied from interface: ApoBase

Returns help information for the option. The information contains all possible settings, except the long description. This might include CLI, property, environment, and other settings.

Specified by:

getHelp in interface ApoBase

Returns:

help information, must not be null

inCli

boolean inCli()

Tests if the option was present in a parsed command line.

Returns:

true if it was present, false otherwise

setInCLi

void setInCLi(boolean inCli)

Sets the option flag for being in a command line.

Parameters:

inCli - true if in a command line, false otherwise

validate

default void validate()
               throws IllegalStateException

Description copied from interface: ApoBase

Validates the option.

Specified by:

validate in interface ApoBase

Throws:

IllegalStateException - for any validation error