Package com.deltaxml.core.config.image

Enum Class ImageComparisonGranularity

java.lang.Object

java.lang.Enum<ImageComparisonGranularity>

com.deltaxml.core.config.image.ImageComparisonGranularity

All Implemented Interfaces:

Serializable, Comparable<ImageComparisonGranularity>, Constable

public enum ImageComparisonGranularity
extends Enum<ImageComparisonGranularity>

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

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 Images by repeating A and B Image inputs adjacent to each other.
DETAILED_ADJACENT	Reports the differences to the Image by repeating the A and B Image inputs adjacent to each other, with individual changes highlighted with bounding boxes in the image.

Method Summary

Modifier and Type	Method	Description
static ImageComparisonGranularity	getImageComparisonGranularity(String val)	Returns the ImageComparisonGranularity instance representing the supplied String value.
String	toString()	The camel case string form of each of the enumerated type constants.
static ImageComparisonGranularity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageComparisonGranularity[]	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 ImageComparisonGranularity ADJACENT

Reports the differences to the Images by repeating A and B Image inputs adjacent to each other. Respective A and B Images will be highlighted with red and green bounding boxes, if a tracked change mode is not the specified output type.

DETAILED_ADJACENT

public static final ImageComparisonGranularity DETAILED_ADJACENT

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

Method Details

values

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

toString

public 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 Enum<ImageComparisonGranularity>

Returns:

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

getImageComparisonGranularity

public static ImageComparisonGranularity getImageComparisonGranularity(String val)

Returns the ImageComparisonGranularity 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 String representation of a ImageComparisonGranularity value or null for the default value

Returns:

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