AppProperties (SVG 2 Vector 2.0.0 API)

Object
- AppProperties<L>

```
public class AppProperties<L extends SV_DocumentLoader>
extends Object
```
Properties and options for SVG2Vector applications.

Since:

v2.0.0

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
`static int`	`P_OPTION_DEAILS` Print option details.
`static int`	`P_OPTION_ERROR` Print option error.
`static int`	`P_OPTION_PROGRESS` Print option progress.
`static int`	`P_OPTION_QUIET` Print option quiet.
`static int`	`P_OPTION_VERBOSE` Print option verbose.
`static int`	`P_OPTION_WARNING` Print option warning.
`static String`	`SUBST_PATTERN_ID` Substitution pattern for layers using layer identifier (id) in output file names.
`static String`	`SUBST_PATTERN_INDEX` Substitution pattern for layers using layer index in output file names.
`protected ArrayList<String>`	`warnings` List of warning messages collected during process.

Constructor Summary

Constructors
Constructor and Description

AppProperties(SvgTargets[] targets, L loader)

Constructors
Constructor and Description
`AppProperties(SvgTargets[] targets, L loader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOption(ApplicationOption<?> option)` Adds an application option.
`boolean`	`canWriteFiles()` Tests if the application is allowed to write output files and directories.
`boolean`	`doesCreateDirectories()` Returns the create-directories flag.
`boolean`	`doesKeepTempArtifacts()` Tests if the application should keep (not remove) temporary artifacts (files and directories).
`boolean`	`doesLayers()` Tests if the properties are set to process layers.
`boolean`	`doesNoLayers()` Tests if the properties are set to process for a single output file, not processing patterns.
`boolean`	`doesSimulate()` Returns the simulation flag.
`boolean`	`doesTextAsShape()` Returns the text-as-shape flag as set by CLI.
`ApplicationOption<?>[]`	`getAppOptions()` Returns the list of added application options.
`String`	`getDout()` Returns the output directory name for processing layers.
`File`	`getDoutFile()` Returns the output directory file for processing layers.
`String`	`getFinFn()` Returns the input file name.
`String`	`getFnOut(Map.Entry<String,Integer> entry)` Returns a file name when dealing with layers.
`String`	`getFnOutNoDir(Map.Entry<String,Integer> entry)` Returns a file name when dealing with layers without any directory element.
`File`	`getFoutFile()` Returns the file for a single output file when not processing layers.
`String`	`getFoutFn()` Returns the file name for a single output file when not processing layers.
`String`	`getFoutPattern()` Returns the generated pattern for output files.
`L`	`getLoader()` Returns the document loader.
`int`	`getMsgMode()` Returns the message mode.
`SvgTargets[]`	`getSupportedTargetts()` Returns the supported targets.
`SvgTargets`	`getTarget()` Returns the application target.
`String`	`getTargetValue()` Returns the set value of the target option.
`ArrayList<String>`	`getWarnings()` Returns current warnings.
`boolean`	`processLayers()` Returns the flag for processing layers individually.
`String`	`setInput()` Tests input file settings and loads it.
`void`	`setMessageMode()` Sets the message mode according to CLI settings.
`String`	`setOutput()` Tests all CLI options that influence output names and sets the output name

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - P_OPTION_QUIET
```
public static int P_OPTION_QUIET
```
    Print option quiet.
  - P_OPTION_ERROR
```
public static int P_OPTION_ERROR
```
    Print option error.
  - P_OPTION_WARNING
```
public static int P_OPTION_WARNING
```
    Print option warning.
  - P_OPTION_PROGRESS
```
public static int P_OPTION_PROGRESS
```
    Print option progress.
  - P_OPTION_DEAILS
```
public static int P_OPTION_DEAILS
```
    Print option details.
  - P_OPTION_VERBOSE
```
public static int P_OPTION_VERBOSE
```
    Print option verbose.
  - SUBST_PATTERN_INDEX
```
public static String SUBST_PATTERN_INDEX
```
    Substitution pattern for layers using layer index in output file names.
  - SUBST_PATTERN_ID
```
public static String SUBST_PATTERN_ID
```
    Substitution pattern for layers using layer identifier (id) in output file names.
  - warnings
```
protected ArrayList<String> warnings
```
    List of warning messages collected during process.
- Constructor Detail
  - AppProperties
```
public AppProperties(SvgTargets[] targets,
                     L loader)
```
- Method Detail
  - addOption
```
public void addOption(ApplicationOption<?> option)
```
    Adds an application option.
    
    Parameters:
    
    option - new option, ignored if null
  - doesLayers
```
public boolean doesLayers()
```
    Tests if the properties are set to process layers.
    
    Returns:
    
    true if set to process layers, false otherwise
  - doesNoLayers
```
public boolean doesNoLayers()
```
    Tests if the properties are set to process for a single output file, not processing patterns.
    
    Returns:
    
    true if set of single output file, false otherwise
  - doesSimulate
```
public boolean doesSimulate()
```
    Returns the simulation flag.
    
    Returns:
    
    true if application is in simulation mode, false otherwise
  - canWriteFiles
```
public boolean canWriteFiles()
```
    Tests if the application is allowed to write output files and directories.
    
    Returns:
    
    true if allowed, false otherwise
  - doesCreateDirectories
```
public boolean doesCreateDirectories()
```
    Returns the create-directories flag.
    
    Returns:
    
    true if application automatically creates directories, false otherwise
  - doesTextAsShape
```
public boolean doesTextAsShape()
```
    Returns the text-as-shape flag as set by CLI.
    
    Returns:
    
    true if text-as-shape is set, false otherwise
  - getAppOptions
```
public ApplicationOption<?>[] getAppOptions()
```
    Returns the list of added application options.
    
    Returns:
    
    application option list, empty if none added
  - getDout
```
public String getDout()
```
    Returns the output directory name for processing layers.
    
    Returns:
    
    directory name, null if not set or errors on setting
  - getDoutFile
```
public File getDoutFile()
```
    Returns the output directory file for processing layers.
    
    Returns:
    
    directory file, null if not set or errors on setting
  - getFinFn
```
public String getFinFn()
```
    Returns the input file name.
    
    Returns:
    
    input file name, null if none set
  - getFnOut
```
public String getFnOut(Map.Entry<String,Integer> entry)
```
    Returns a file name when dealing with layers.
    
    Parameters:
    
    entry - file name, null if entry or any parts was null or if not set to process layers
    
    Returns:
    
    file name with directory element
  - getFnOutNoDir
```
public String getFnOutNoDir(Map.Entry<String,Integer> entry)
```
    Returns a file name when dealing with layers without any directory element.
    
    Parameters:
    
    entry - file name, null if entry or any parts was null or if not set to process layers
    
    Returns:
    
    file name without directory element
  - getFoutFn
```
public String getFoutFn()
```
    Returns the file name for a single output file when not processing layers.
    
    Returns:
    
    file name, null if not set or if errors on setting
  - getFoutFile
```
public File getFoutFile()
```
    Returns the file for a single output file when not processing layers.
    
    Returns:
    
    file, null if not set or if errors on setting
  - getFoutPattern
```
public String getFoutPattern()
```
    Returns the generated pattern for output files.
    
    Returns:
    
    generated pattern, null if not set
  - getLoader
```
public L getLoader()
```
    Returns the document loader.
    
    Returns:
    
    the document loader
  - getMsgMode
```
public int getMsgMode()
```
    Returns the message mode.
    
    Returns:
    
    message mode: 0 for quiet, bit mask otherwise
  - getSupportedTargetts
```
public SvgTargets[] getSupportedTargetts()
```
    Returns the supported targets.
    
    Returns:
    
    supported targets
  - getTarget
```
public SvgTargets getTarget()
```
    Returns the application target.
    
    Returns:
    
    application target, null if none set or if a set target was not in the list of supported targets
  - getTargetValue
```
public String getTargetValue()
```
    Returns the set value of the target option.
    
    Returns:
    
    target option value
  - getWarnings
```
public ArrayList<String> getWarnings()
```
    Returns current warnings.
    
    Returns:
    
    current warnings, empty (size 0) if none collected
  - processLayers
```
public boolean processLayers()
```
    Returns the flag for processing layers individually.
    
    Returns:
    
    true if layers should be processed, false otherwise
  - setInput
```
public String setInput()
```
    Tests input file settings and loads it.
    
    Returns:
    
    null in success, error string on error
  - setMessageMode
```
public void setMessageMode()
```
    Sets the message mode according to CLI settings.
  - setOutput
```
public String setOutput()
```
    Tests all CLI options that influence output names and sets the output name
    
    Returns:
    
    null in success, error string on error
  - doesKeepTempArtifacts
```
public boolean doesKeepTempArtifacts()
```
    Tests if the application should keep (not remove) temporary artifacts (files and directories).
    
    Returns:
    
    true if artifacts should be kept, false otherwise

Class AppProperties<L extends SV_DocumentLoader>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

P_OPTION_QUIET

P_OPTION_ERROR

P_OPTION_WARNING

P_OPTION_PROGRESS

P_OPTION_DEAILS

P_OPTION_VERBOSE

SUBST_PATTERN_INDEX

SUBST_PATTERN_ID

warnings

Constructor Detail

AppProperties

Method Detail

addOption

doesLayers

doesNoLayers

doesSimulate

canWriteFiles

doesCreateDirectories

doesTextAsShape

getAppOptions

getDout

getDoutFile

getFinFn

getFnOut

getFnOutNoDir

getFoutFn

getFoutFile

getFoutPattern

getLoader

getMsgMode

getSupportedTargetts

getTarget

getTargetValue

getWarnings

processLayers

setInput

setMessageMode

setOutput

doesKeepTempArtifacts