Package com.deltaxml.docbook.config

Enum Class SVGGranularity

java.lang.Object

java.lang.Enum<SVGGranularity>

com.deltaxml.docbook.config.SVGGranularity

All Implemented Interfaces:

com.deltaxml.docbook.DocBookCompareDisplayable, Serializable, Comparable<SVGGranularity>, Constable

public enum SVGGranularity
extends Enum<SVGGranularity>
implements com.deltaxml.docbook.DocBookCompareDisplayable

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

Since:

12.2

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
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	Description
String	getDisplayDescription()	Returns the user friendly String description of an Enum parameter value.
String	getDisplayName()	Returns the user friendly String name of an Enum parameter value.
String	toString()
static SVGGranularity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SVGGranularity[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

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

getDisplayName

public String getDisplayName()

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

Specified by:

getDisplayName in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user friendly String representing an Enum parameter object

getDisplayDescription

public String getDisplayDescription()

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

Specified by:

getDisplayDescription in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user friendly String description representing an Enum parameter object

toString

public String toString()

Overrides:

toString in class Enum<SVGGranularity>