Record Class VisualProcessingProvider.ScreenshotComparisonResult

java.lang.Object

java.lang.Record

com.shaft.gui.internal.image.VisualProcessingProvider.ScreenshotComparisonResult

Record Components:

matched - true when the observed pixel difference is within the configured budget

diffImage - encoded PNG highlighting the differing pixels, or an empty array when matched is true

diffPixels - number of pixels that differ after masking

diffRatio - diffPixels divided by the total pixel count of the compared images

Enclosing interface:

VisualProcessingProvider

public static record VisualProcessingProvider.ScreenshotComparisonResult(boolean matched, byte[] diffImage, long diffPixels, double diffRatio)
extends Record

Result of a pixel-level screenshot comparison against a baseline image.

Constructor Summary

Constructors

Constructor	Description
ScreenshotComparisonResult(boolean matched, byte[] diffImage, long diffPixels, double diffRatio)	Creates an instance of a ScreenshotComparisonResult record class.

Method Summary

Modifier and Type	Method	Description
byte[]	diffImage()	Returns the value of the diffImage record component.
long	diffPixels()	Returns the value of the diffPixels record component.
double	diffRatio()	Returns the value of the diffRatio record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	matched()	Returns the value of the matched record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScreenshotComparisonResult

public ScreenshotComparisonResult(boolean matched,
 byte[] diffImage,
 long diffPixels,
 double diffRatio)

Creates an instance of a ScreenshotComparisonResult record class.

Parameters:

matched - the value for the matched record component

diffImage - the value for the diffImage record component

diffPixels - the value for the diffPixels record component

diffRatio - the value for the diffRatio record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

matched

public boolean matched()

Returns the value of the matched record component.

Returns:

the value of the matched record component

diffImage

public byte[] diffImage()

Returns the value of the diffImage record component.

Returns:

the value of the diffImage record component

diffPixels

public long diffPixels()

Returns the value of the diffPixels record component.

Returns:

the value of the diffPixels record component

diffRatio

public double diffRatio()

Returns the value of the diffRatio record component.

Returns:

the value of the diffRatio record component