Package com.inet.pdfc.generator.model
Enum DiffGroup.GroupType
- java.lang.Object
-
- java.lang.Enum<DiffGroup.GroupType>
-
- com.inet.pdfc.generator.model.DiffGroup.GroupType
-
- All Implemented Interfaces:
com.inet.pdfc.config.ColorSetting
,VisibilitySetting
,java.io.Serializable
,java.lang.Comparable<DiffGroup.GroupType>
- Enclosing class:
- DiffGroup
public static enum DiffGroup.GroupType extends java.lang.Enum<DiffGroup.GroupType> implements com.inet.pdfc.config.ColorSetting
Defines the type of aDiffGroup
and thus how to interpret the content of the affected elements lists. The enumeration is ordered in descending order by severity. For further details about each type refer to the respective enum constant.- Since:
- 3.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AddedOrRemoved
ContainsModification
s which describe a remove in the first document or an add in the second document.
NOTE: There is no clear line between this type and 'Replaced'.MetadataChanged
This type occurs for changes in the meta data or a page or the whole document.Modified
The modified type indicates that the content in this group is similar on both documents but changed in style.Replaced
For this type, theModification
s contain elements of similar type and equal style(per side).Sync
This is an optional type which is added by the generator at any identical locations in the document flow to help any graphical presenter to keep the presented pages in sync.ValidationError
A validation error is an indicator for a problem on a singular element.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getLocalizedName()
Returns the localized name for this typejava.lang.String
getTyp()
The Visibility Type for this Setting (Enum)boolean
isTypePainted()
Indicates whether this group type is paintedstatic DiffGroup.GroupType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static DiffGroup.GroupType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.static DiffGroup.GroupType[]
valuesVisible()
Returns the groups which should be visible to the user by default.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.inet.pdfc.config.VisibilitySetting
getTranslationKey, name
-
-
-
-
Enum Constant Detail
-
AddedOrRemoved
public static final DiffGroup.GroupType AddedOrRemoved
ContainsModification
s which describe a remove in the first document or an add in the second document.
NOTE: There is no clear line between this type and 'Replaced'. The only difference is that this type is likely to contain mixed types of affected elements.
-
Replaced
public static final DiffGroup.GroupType Replaced
For this type, theModification
s contain elements of similar type and equal style(per side). This type is a special case of AddedOrRemoved. It is very likely but not guaranteed to be a content replacement.
-
Modified
public static final DiffGroup.GroupType Modified
The modified type indicates that the content in this group is similar on both documents but changed in style. As a result, both allModification
contain the same number of elements and each element is similar to it's counterpart in the other document.
-
ValidationError
public static final DiffGroup.GroupType 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 DiffGroup.GroupType 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.
-
Sync
public static final DiffGroup.GroupType Sync
This is an optional type which is added by the generator at any identical locations in the document flow to help any graphical presenter to keep the presented pages in sync. If you don't need this feature, it's sufficient to ignore this type of groups
The differences count of these groups will always yield zero.
-
-
Method Detail
-
values
public static DiffGroup.GroupType[] 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 (DiffGroup.GroupType c : DiffGroup.GroupType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DiffGroup.GroupType 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 namejava.lang.NullPointerException
- if the argument is null
-
isTypePainted
public boolean isTypePainted()
Indicates whether this group type is painted- Returns:
- whether this group type is painted
-
valuesVisible
public static DiffGroup.GroupType[] valuesVisible()
Returns the groups which should be visible to the user by default. This excludes the sync-type for instance.- Returns:
- the groups which should be visible to the user by default
-
getLocalizedName
public java.lang.String getLocalizedName()
Returns the localized name for this type- Returns:
- the localized name for this type
-
getTyp
public java.lang.String getTyp()
Description copied from interface:VisibilitySetting
The Visibility Type for this Setting (Enum)- Specified by:
getTyp
in interfaceVisibilitySetting
- Returns:
- Type of Enum
-
-