Package com.inet.pdfc.generator.model

Enum Class Modification.ModificationType

java.lang.Object

java.lang.Enum<Modification.ModificationType>

com.inet.pdfc.generator.model.Modification.ModificationType

All Implemented Interfaces:

com.inet.pdfc.config.ColorSetting, VisibilitySetting, Serializable, Comparable<Modification.ModificationType>, Constable

Enclosing class:

Modification

public static enum Modification.ModificationType
extends Enum<Modification.ModificationType>
implements com.inet.pdfc.config.ColorSetting

The type of the modification which side has modifications and whether the changes do apply- This is loosely coupled to the severity type of DiffGroups.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
add	There are only new affected elements in the second document.
attributeDifference	There are affected elements in both documents and their number is equal as they are themselves basically equal.
metadataChanged	This type occurs for changes in the meta data or a page or the whole document.
remove	There are only removed affected elements in the first document.
replace	There are affected elements in both documents but their number may differ.
validationError	A validation error is an indicator for a problem on a singular element.

Method Summary

Modifier and Type	Method	Description
String	getLocalizedName()	Returns the localized name for this type
String	getTyp()	The Visibility Type for this Setting (Enum)
static Modification.ModificationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Modification.ModificationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inet.pdfc.config.VisibilitySetting

getTranslationKey, name

Enum Constant Details

add

public static final Modification.ModificationType add

There are only new affected elements in the second document. Attribute changes do not apply and are empty.

remove

public static final Modification.ModificationType remove

There are only removed affected elements in the first document. Attribute changes do not apply and are empty.

replace

public static final Modification.ModificationType replace

There are affected elements in both documents but their number may differ. Attribute changes do not apply and are empty.

attributeDifference

public static final Modification.ModificationType attributeDifference

There are affected elements in both documents and their number is equal as they are themselves basically equal. Since their style or other attributed where changed, the attribute-difference does apply to all elements in this modification.

validationError

public static final Modification.ModificationType validationError

A validation error is an indicator for a problem on a singular element. The Element will only be highlighted, but no grouped change should be displayed.

Since:

5.2

metadataChanged

public static final Modification.ModificationType metadataChanged

This type occurs for changes in the meta data or a page or the whole document.
NOTE: These elements in this group have artificial bounds to place them at least inside the document area. Their bounds do NOT necessarily represent the bounds of the references pages, the document, etc.

Since:

25.10

Method Details

values

public static Modification.ModificationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Modification.ModificationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTyp

public String getTyp()

Description copied from interface: VisibilitySetting

The Visibility Type for this Setting (Enum)

Specified by:

getTyp in interface VisibilitySetting

Returns:

Type of Enum

getLocalizedName

public String getLocalizedName()

Returns the localized name for this type

Returns:

the localized name for this type