protected static enum PDFC.PROP extends java.lang.Enum<PDFC.PROP> implements CommandLineParameter
Enum Constant and 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_FORMAT
Defines the export format in case export is 'report' or the -e option is set
|
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
PDFC.PROP.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.
|
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. |
Modifier and Type | Method and 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.
|
public static final PDFC.PROP ACTIVATE
public static final PDFC.PROP INFO
public static final PDFC.PROP REUQESTANDACTIVATETRIAL
public static final PDFC.PROP CONFIG
public static final PDFC.PROP ROOT
public static final PDFC.PROP PRESENTERS
public static final PDFC.PROP OPTION_PRINT
public static final PDFC.PROP OPTION_EXPORT
public static final PDFC.PROP EXPORT_FORMAT
public static final PDFC.PROP COLLAPSE
public static final PDFC.PROP TYPES
DiffGroup.GroupType
s to show in the result. All are enabled by default.
Values: List of TYPE_ contantspublic static final PDFC.PROP HIGHLIGHTS
public static final PDFC.PROP SIDES
both
public static final PDFC.PROP HEADER
true
public static final PDFC.PROP SCALE
false
public static final PDFC.PROP OVERLAP
false
@Deprecated public static final PDFC.PROP ONLYDIFFERENCES
PDFC.PROP.EXPORTALWAYS
true
the export PDF and PNGs will only be
created in case of differences. Default is true
public static final PDFC.PROP EXPORTALWAYS
public static final PDFC.PROP OPTION_XOR_IMAGES
public static final PDFC.PROP OPTION_ORIGINAL_IMAGES
public static final PDFC.PROP OPTION_CREATE_FIRST_IMAGES
public static final PDFC.PROP OPTION_CREATE_SECOND_IMAGES
public static final PDFC.PROP OPTION_CREATE_DIFF_IMAGES
public static final PDFC.PROP PASSWORD1
public static final PDFC.PROP PASSWORD2
public static PDFC.PROP[] values()
for (PDFC.PROP c : PDFC.PROP.values()) System.out.println(c);
public static PDFC.PROP valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getKey()
getKey
in interface CommandLineParameter
null
if not usedpublic char getShortcut()
getShortcut
in interface CommandLineParameter
public boolean hasValue()
hasValue
in interface CommandLineParameter
true
if the next parameter is the argument to this parameterpublic java.lang.String getMissingArgMsg()
CommandLineParameter.hasValue()
is true but no argument was passed. If CommandLineParameter.hasValue()
returns false
, this method may return null
.getMissingArgMsg
in interface CommandLineParameter
CommandLineParameter.hasValue()
is true but no argument was passedpublic void execute(PDFC.ComparisonParameters parameters, java.lang.String optionalParameter)
execute
in interface CommandLineParameter
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 parameterpublic java.lang.String getHelpMessage()
getHelpMessage
in interface CommandLineParameter
null
for no help contentCopyright © 2010-2022 by i-net software GmbH