com.deltaxml.docbook

Enum SVGGranularity

java.lang.Object

java.lang.Enum<SVGGranularity>

com.deltaxml.docbook.SVGGranularity

All Implemented Interfaces:

DocBookCompareDisplayable, java.io.Serializable, java.lang.Comparable<SVGGranularity>

public enum SVGGranularity
extends java.lang.Enum<SVGGranularity>
implements DocBookCompareDisplayable

Specifies the granularity at which the differences between the two SVG images will be represented from the DocumentComparator.

Since:

12.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJACENT Reports the differences to the SVG by repeating A and B SVG inputs adjacent to each other.
ANIMATE_INLINE Reports SVG differences by animating them by changing the opacity from 1 to 0 for delete and 0 to 1 for add.
DETAILED_ADJACENT Reports the differences to the SVG by repeating the A and B SVG inputs adjacent to each other, with individual changes highlighted with bounding boxes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayDescription() Returns the user friendly String description of an Enum parameter value.
java.lang.String	getDisplayName() Returns the user friendly String name of an Enum parameter value.
static SVGGranularity	getSVGGranularity(java.lang.String val) Returns the SVGGranularity instance representing the supplied String value.
static SVGGranularity	parseValue(java.lang.String value)
java.lang.String	toString() The camel case string form of each of the enumerated type constants.
static SVGGranularity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SVGGranularity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJACENT

public static final SVGGranularity ADJACENT

Reports the differences to the SVG by repeating A and B SVG inputs adjacent to each other. Respective A and B SVGs will be highlighted with red and green bounding boxes .

DETAILED_ADJACENT

public static final SVGGranularity DETAILED_ADJACENT

Reports the differences to the SVG by repeating the A and B SVG inputs adjacent to each other, with individual changes highlighted with bounding boxes.

ANIMATE_INLINE

public static final SVGGranularity ANIMATE_INLINE

Reports SVG differences by animating them by changing the opacity from 1 to 0 for delete and 0 to 1 for add. This setting will override any other SVG configuration.

Method Detail

values

public static SVGGranularity[] 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 (SVGGranularity c : SVGGranularity.values())
    System.out.println(c);

Returns:

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

valueOf

public static SVGGranularity 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

toString

public java.lang.String toString()

The camel case string form of each of the enumerated type constants. Here, the string for an enumeration constant of the form 'FIRST_SECOND_THIRD' is 'firstSecondThird'.

Overrides:

toString in class java.lang.Enum<SVGGranularity>

Returns:

The camel case string form of each of the enumerated type constants.

getSVGGranularity

public static SVGGranularity getSVGGranularity(java.lang.String val)

Returns the SVGGranularity instance representing the supplied String value.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

val - a Sting representation of a SVGGranularity value or null for the default value

Returns:

the SVGGranularity instance corresponding to the parameter, or null if the value is invalid

parseValue

public static SVGGranularity parseValue(java.lang.String value)

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: DocBookCompareDisplayable

Returns the user friendly String name of an Enum parameter value.

Specified by:

getDisplayName in interface DocBookCompareDisplayable

Returns:

a user friendly String representing an Enum parameter object

getDisplayDescription

public java.lang.String getDisplayDescription()

Description copied from interface: DocBookCompareDisplayable

Returns the user friendly String description of an Enum parameter value.

Specified by:

getDisplayDescription in interface DocBookCompareDisplayable

Returns:

a user friendly String description representing an Enum parameter object