java.lang.Object
- java.lang.Enum<PDFC.PROP>
- - com.inet.pdfc.PDFC.PROP

All Implemented Interfaces:

CommandLineParameter, java.io.Serializable, java.lang.Comparable<PDFC.PROP>

Enclosing class:

PDFC
```
protected static enum PDFC.PROP
extends java.lang.Enum<PDFC.PROP>
implements CommandLineParameter
```
Enum of all known command line switches and options, along with their long and short for and info about their default value and whether they require a parameter

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ACTIVATE`	Switch to activate a license or activation key
`COLLAPSE`	Option to make pages without diffs in pdf-export to be collapsed
`CONFIG`	Switch to set the configuration file
`EXPORT_FONT_EMBEDDING`	Toggle the font replacement and embedding for system font references when exporting to PDF
`EXPORT_FORMAT`	Defines the export format in case export is 'report' or the -e option is set
`EXPORT_PW`
`EXPORTALWAYS`	Default export PDF by difference, if no difference available it doesn't export.
`HEADER`	Boolean switch to enable or disable the header/footer in print, PDF and PNG.
`HIGHLIGHTS`	Defines which filters may show highlights in the print, PDF or PNG output.
`INFO`	Switch to print debug and support informations to the console
`ONLYDIFFERENCES`	Deprecated. As of i-net PDFC 5.0, use instead see `EXPORTALWAYS`
`OPTION_CREATE_DIFF_IMAGES`	Option to enable the creation of differences images
`OPTION_CREATE_FIRST_IMAGES`	Option to enable the creation of difference images for the pages of the first PDF
`OPTION_CREATE_SECOND_IMAGES`	Option to enable the creation of difference images for the pages of the second PDF
`OPTION_EXPORT`	Option to enable the PDF report export.
`OPTION_ORIGINAL_IMAGES`	Option to enable the generation of original page images
`OPTION_PRINT`	Option to enable the print export
`OPTION_XOR_IMAGES`	Option to enable the creation of XOR images
`OVERLAP`	Boolean switch to enable or disable the overlap mode in print, PDF and PNG.
`PASSWORD1`	Sets the password for the first PDF file
`PASSWORD2`	Sets the password for the second PDF file
`PRESENTERS`	Parameter for the export presenters to be used.
`RETRY_BATCH`	Boolean switch to retry failed comparisons in batch mode.
`REUQESTANDACTIVATETRIAL`
`ROOT`	Switch to set the root folder for the report and difference images
`SCALE`	Boolean switch to enable or disable 'scale to fit page' in print, PDF and PNG.
`SIDES`	The sides to export, when using print, PDF or PNG.
`TYPES`	The `DiffGroup.GroupType`s to show in the result.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(PDFC.ComparisonParameters parameters, java.lang.String optionalParameter)`	Executes the parameter to modify the comparison configuration accordingly.
`java.lang.String`	`getHelpMessage()`	Returns a string to attach to the list of commands of the tool.
`java.lang.String`	`getKey()`	Returns the long/full key of the parameter.
`java.lang.String`	`getMissingArgMsg()`	Returns the message in case `CommandLineParameter.hasValue()` is true but no argument was passed.
`char`	`getShortcut()`	Returns the single character short cut switch, use a space if no shortcut can be used.
`boolean`	`hasValue()`	Returns whether the parameter requires an additional argument like a path.
`static PDFC.PROP`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static PDFC.PROP[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ACTIVATE
```
public static final PDFC.PROP ACTIVATE
```
    Switch to activate a license or activation key
  - INFO
```
public static final PDFC.PROP INFO
```
    Switch to print debug and support informations to the console
  - REUQESTANDACTIVATETRIAL
```
public static final PDFC.PROP REUQESTANDACTIVATETRIAL
```
  - CONFIG
```
public static final PDFC.PROP CONFIG
```
    Switch to set the configuration file
  - ROOT
```
public static final PDFC.PROP ROOT
```
    Switch to set the root folder for the report and difference images
  - PRESENTERS
```
public static final PDFC.PROP PRESENTERS
```
    Parameter for the export presenters to be used. Console is always enabled. Values: List if the export presenter names, see EXPORT constants
  - OPTION_PRINT
```
public static final PDFC.PROP OPTION_PRINT
```
    Option to enable the print export
  - OPTION_EXPORT
```
public static final PDFC.PROP OPTION_EXPORT
```
    Option to enable the PDF report export.
  - EXPORT_FORMAT
```
public static final PDFC.PROP EXPORT_FORMAT
```
    Defines the export format in case export is 'report' or the -e option is set
  - EXPORT_PW
```
public static final PDFC.PROP EXPORT_PW
```
  - EXPORT_FONT_EMBEDDING
```
public static final PDFC.PROP EXPORT_FONT_EMBEDDING
```
    Toggle the font replacement and embedding for system font references when exporting to PDF
  - COLLAPSE
```
public static final PDFC.PROP COLLAPSE
```
    Option to make pages without diffs in pdf-export to be collapsed
  - TYPES
```
public static final PDFC.PROP TYPES
```
    The DiffGroup.GroupTypes to show in the result. All are enabled by default. Values: List of TYPE_ contants
  - HIGHLIGHTS
```
public static final PDFC.PROP HIGHLIGHTS
```
    Defines which filters may show highlights in the print, PDF or PNG output. By default, all are disabled.
  - SIDES
```
public static final PDFC.PROP SIDES
```
    The sides to export, when using print, PDF or PNG. Values: left, right or both. Default is both
  - HEADER
```
public static final PDFC.PROP HEADER
```
    Boolean switch to enable or disable the header/footer in print, PDF and PNG. Default is true
  - SCALE
```
public static final PDFC.PROP SCALE
```
    Boolean switch to enable or disable 'scale to fit page' in print, PDF and PNG. Default is false
  - OVERLAP
```
public static final PDFC.PROP OVERLAP
```
    Boolean switch to enable or disable the overlap mode in print, PDF and PNG. Default is false
  - ONLYDIFFERENCES
```
@Deprecated
public static final PDFC.PROP ONLYDIFFERENCES
```
    Deprecated.
    As of i-net PDFC 5.0, use instead see EXPORTALWAYS
    
    Boolean switch, if true the export PDF and PNGs will only be created in case of differences. Default is true
  - EXPORTALWAYS
```
public static final PDFC.PROP EXPORTALWAYS
```
    Default export PDF by difference, if no difference available it doesn't export. Switch change the condition and export everytime. Replace the old parameter "exportonlyondifferences" and the config.xml property "PDFALWAYS" If both command parameter available ('exportonlyondifferences' and 'exportAlways'), the new parameter will be taken. This parameter is equivalent with -exportonlyondifferences=false
  - RETRY_BATCH
```
public static final PDFC.PROP RETRY_BATCH
```
    Boolean switch to retry failed comparisons in batch mode. This may help if the parallel execution of the comparisons causes memory errors.
  - OPTION_XOR_IMAGES
```
public static final PDFC.PROP OPTION_XOR_IMAGES
```
    Option to enable the creation of XOR images
  - OPTION_ORIGINAL_IMAGES
```
public static final PDFC.PROP OPTION_ORIGINAL_IMAGES
```
    Option to enable the generation of original page images
  - OPTION_CREATE_FIRST_IMAGES
```
public static final PDFC.PROP OPTION_CREATE_FIRST_IMAGES
```
    Option to enable the creation of difference images for the pages of the first PDF
  - OPTION_CREATE_SECOND_IMAGES
```
public static final PDFC.PROP OPTION_CREATE_SECOND_IMAGES
```
    Option to enable the creation of difference images for the pages of the second PDF
  - OPTION_CREATE_DIFF_IMAGES
```
public static final PDFC.PROP OPTION_CREATE_DIFF_IMAGES
```
    Option to enable the creation of differences images
  - PASSWORD1
```
public static final PDFC.PROP PASSWORD1
```
    Sets the password for the first PDF file
  - PASSWORD2
```
public static final PDFC.PROP PASSWORD2
```
    Sets the password for the second PDF file
- Method Detail
  - values
```
public static PDFC.PROP[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PDFC.PROP c : PDFC.PROP.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PDFC.PROP valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getKey
```
public java.lang.String getKey()
```
    Returns the long/full key of the parameter.
    
    Specified by:
    
    getKey in interface CommandLineParameter
    
    Returns:
    
    the long/full key of the parameter, may be null if not used
  - getShortcut
```
public char getShortcut()
```
    Returns the single character short cut switch, use a space if no shortcut can be used. Short cuts can be combined into a single parameter. It's recommended to only provide a shortcut if no parameter is required since the additional value would be ambiguous in case of combined parameters.
    
    Specified by:
    
    getShortcut in interface CommandLineParameter
    
    Returns:
    
    the single character short cut switch or 0x00 if no shortcut is provided
  - hasValue
```
public boolean hasValue()
```
    Returns whether the parameter requires an additional argument like a path.
    
    Specified by:
    
    hasValue in interface CommandLineParameter
    
    Returns:
    
    true if the next parameter is the argument to this parameter
  - getMissingArgMsg
```
public java.lang.String getMissingArgMsg()
```
    Returns the message in case CommandLineParameter.hasValue() is true but no argument was passed. If CommandLineParameter.hasValue() returns false, this method may return null.
    
    Specified by:
    
    getMissingArgMsg in interface CommandLineParameter
    
    Returns:
    
    the message in case CommandLineParameter.hasValue() is true but no argument was passed
  - execute
```
public void execute(PDFC.ComparisonParameters parameters,
                    java.lang.String optionalParameter)
```
    Executes the parameter to modify the comparison configuration accordingly.
    
    Specified by:
    
    execute in interface CommandLineParameter
    
    Parameters:
    
    parameters - the configuration instance for the comparison to run after all command line parameters have been evaluated.
    
    optionalParameter - if CommandLineParameter.hasValue() yields true, the caller will pass the additional value in this parameter
  - getHelpMessage
```
public java.lang.String getHelpMessage()
```
    Returns a string to attach to the list of commands of the tool. Must not have a leading or tailing break character! Use the default locale of the JVM for the translation.
    
    Specified by:
    
    getHelpMessage in interface CommandLineParameter
    
    Returns:
    
    a string to attach to the list of commands of the tool or null for no help content

Enum PDFC.PROP

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ACTIVATE

INFO

REUQESTANDACTIVATETRIAL

CONFIG

ROOT

PRESENTERS

OPTION_PRINT

OPTION_EXPORT

EXPORT_FORMAT

EXPORT_PW

EXPORT_FONT_EMBEDDING

COLLAPSE

TYPES

HIGHLIGHTS

SIDES

HEADER

SCALE

OVERLAP

ONLYDIFFERENCES

EXPORTALWAYS

RETRY_BATCH

OPTION_XOR_IMAGES

OPTION_ORIGINAL_IMAGES

OPTION_CREATE_FIRST_IMAGES

OPTION_CREATE_SECOND_IMAGES

OPTION_CREATE_DIFF_IMAGES

PASSWORD1

PASSWORD2

Method Detail

values

valueOf

getKey

getShortcut

hasValue

getMissingArgMsg

execute

getHelpMessage