Package com.github.romankh3.image.comparison.model

Class ImageComparisonResult

java.lang.Object

com.github.romankh3.image.comparison.model.ImageComparisonResult

public class ImageComparisonResult
extends java.lang.Object

Data transfer objects which contains all the needed data for result of the comparison.

Constructor Summary

Constructors

Constructor	Description
ImageComparisonResult()

Method Summary

Modifier and Type	Method	Description
static ImageComparisonResult	defaultMatchResult(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual)	Create default instance of the ImageComparisonResult with ImageComparisonState.MATCH.
static ImageComparisonResult	defaultMisMatchResult(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual, float differencePercent)	Create default instance of the ImageComparisonResult with ImageComparisonState.MISMATCH.
static ImageComparisonResult	defaultSizeMisMatchResult(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual, float differencePercent)	Create default instance of the ImageComparisonResult with ImageComparisonState.SIZE_MISMATCH.
java.awt.image.BufferedImage	getActual()
float	getDifferencePercent()
java.awt.image.BufferedImage	getExpected()
ImageComparisonState	getImageComparisonState()
java.util.List<Rectangle>	getRectangles()
java.awt.image.BufferedImage	getResult()
ImageComparisonResult	setActual(java.awt.image.BufferedImage actual)
ImageComparisonResult	setExpected(java.awt.image.BufferedImage expected)
ImageComparisonResult	setImageComparisonState(ImageComparisonState imageComparisonState)
ImageComparisonResult	setRectangles(java.util.List<Rectangle> rectangles)
ImageComparisonResult	setResult(java.awt.image.BufferedImage result)
ImageComparisonResult	writeResultTo(java.io.File file)	Save the image to the provided File object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageComparisonResult

public ImageComparisonResult()

Method Detail

defaultSizeMisMatchResult

public static ImageComparisonResult defaultSizeMisMatchResult(java.awt.image.BufferedImage expected,
                                                              java.awt.image.BufferedImage actual,
                                                              float differencePercent)

Create default instance of the ImageComparisonResult with ImageComparisonState.SIZE_MISMATCH.

Parameters:

expected - expected BufferedImage object.

actual - actual BufferedImage object.

differencePercent - the percent of the differences between images.

Returns:

instance of the ImageComparisonResult object.

defaultMisMatchResult

public static ImageComparisonResult defaultMisMatchResult(java.awt.image.BufferedImage expected,
                                                          java.awt.image.BufferedImage actual,
                                                          float differencePercent)

Create default instance of the ImageComparisonResult with ImageComparisonState.MISMATCH.

Parameters:

expected - expected BufferedImage object.

actual - actual BufferedImage object.

differencePercent - the persent of the differences between images.

Returns:

instance of the ImageComparisonResult object.

defaultMatchResult

public static ImageComparisonResult defaultMatchResult(java.awt.image.BufferedImage expected,
                                                       java.awt.image.BufferedImage actual)

Create default instance of the ImageComparisonResult with ImageComparisonState.MATCH.

Parameters:

expected - expected BufferedImage object.

actual - actual BufferedImage object.

Returns:

instance of the ImageComparisonResult object.

writeResultTo

public ImageComparisonResult writeResultTo(java.io.File file)

Save the image to the provided File object.

Parameters:

file - the provided File object.

Returns:

this ImageComparisonResult object.

getExpected

public java.awt.image.BufferedImage getExpected()

setExpected

public ImageComparisonResult setExpected(java.awt.image.BufferedImage expected)

getActual

public java.awt.image.BufferedImage getActual()

setActual

public ImageComparisonResult setActual(java.awt.image.BufferedImage actual)

getResult

public java.awt.image.BufferedImage getResult()

setResult

public ImageComparisonResult setResult(java.awt.image.BufferedImage result)

getImageComparisonState

public ImageComparisonState getImageComparisonState()

setImageComparisonState

public ImageComparisonResult setImageComparisonState(ImageComparisonState imageComparisonState)

getDifferencePercent

public float getDifferencePercent()

getRectangles

public java.util.List<Rectangle> getRectangles()

setRectangles

public ImageComparisonResult setRectangles(java.util.List<Rectangle> rectangles)