de.vandermeer.svg2vector.applications.base

Class AO_TargetExt

Object

AbstractApplicationOption<String>

AO_Target

AO_TargetExt

All Implemented Interfaces:

ApplicationOption<String>

public class AO_TargetExt
extends AO_Target

Application option target with extended long description.

Since:

v1.1.1

Version:

v2.0.0 build 170413 (13-Apr-17) for Java 1.8

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected SvgTargets[]	supportedTargets The supported targets of the application.

Fields inherited from class AbstractApplicationOption

cliOption, descr, descrLong, inCli, optionKey, valueCli, ValueDefault, valueProperty

Constructor Summary

Constructors

Constructor and Description
AO_TargetExt(boolean required, Character shortOption, String longDescription, SvgTargets[] supportedTargets) Returns the new option.

Method Summary

Modifier and Type	Method and Description
protected static String	buildLongDescr(String descr, SvgTargets[] supportedTargets) Creates a long description with supported targets.
SvgTargets[]	getSupportedTargets() Returns the supported targets.
SvgTargets	getTarget() Returns the target for a given set value.

Methods inherited from class AO_Target

convertValue

Methods inherited from class AbstractApplicationOption

getCliOption, getCliValue, getDefaultValue, getDescription, getDescriptionLong, getOptionKey, getPropertValue, inCli, setCliOption, setCliValue, setDefaultValue, setDescriptionLong, setPropertyValue

Methods inherited from class Object

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

Methods inherited from interface ApplicationOption

cliOptionAsString, getUsage, getValue

Field Detail

supportedTargets

protected SvgTargets[] supportedTargets

The supported targets of the application.

Constructor Detail

AO_TargetExt

public AO_TargetExt(boolean required,
                    Character shortOption,
                    String longDescription,
                    SvgTargets[] supportedTargets)

Returns the new option.

Parameters:

required - true if option is required, false of it is optional

shortOption - character for sort version of the option

longDescription - option long description

supportedTargets - list of supported targets

Throws:

NullPointerException - - if description parameter is null

IllegalArgumentException - - if description parameter is empty

Method Detail

buildLongDescr

protected static String buildLongDescr(String descr,
                                       SvgTargets[] supportedTargets)

Creates a long description with supported targets.

Parameters:

descr - original long description

supportedTargets - targets

Returns:

long description with added list of supported targets

Throws:

NullPointerException - if argument was null

getSupportedTargets

public SvgTargets[] getSupportedTargets()

Returns the supported targets.

Returns:

supported targets

getTarget

public SvgTargets getTarget()

Returns the target for a given set value.

Returns:

the target if valid value in the option, null if no value was set or the required target not in the list of supported targets