org.assertj.swing.internal.assertions

Class Images

java.lang.Object

org.assertj.swing.internal.assertions.Images

public class Images
extends Object

Reusable assertions for BufferedImages.

Author:

Yvonne Wang

Method Summary

Modifier and Type	Method and Description
void	assertEqual(org.assertj.core.api.AssertionInfo info, BufferedImage actual, BufferedImage expected) Asserts that two images are equal.
void	assertEqual(org.assertj.core.api.AssertionInfo info, BufferedImage actual, BufferedImage expected, org.assertj.core.data.Offset<Integer> offset) Asserts that two images are equal.
void	assertHasSize(org.assertj.core.api.AssertionInfo info, BufferedImage actual, Dimension size) Asserts that the size of the given image is equal to the given size.
void	assertNotEqual(org.assertj.core.api.AssertionInfo info, BufferedImage actual, BufferedImage other) Asserts that two images are not equal.
static Images	instance() Returns the singleton instance of this class.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static Images instance()

Returns the singleton instance of this class.

Returns:

the singleton instance of this class.

assertEqual

public void assertEqual(org.assertj.core.api.AssertionInfo info,
                        BufferedImage actual,
                        BufferedImage expected)

Asserts that two images are equal. Two images are equal if:

1. they have equal size
2. the the RGB values of the color at each pixel are equal

Parameters:

info - contains information about the assertion.

actual - the actual image.

expected - the expected image.

Throws:

AssertionError - if the actual image is not equal to the expected one.

assertEqual

public void assertEqual(org.assertj.core.api.AssertionInfo info,
                        BufferedImage actual,
                        BufferedImage expected,
                        org.assertj.core.data.Offset<Integer> offset)

Asserts that two images are equal. Two images are equal if:

1. they have the same size
2. the difference between the RGB values of the color at each pixel is less than or equal to the given offset

Parameters:

info - contains information about the assertion.

actual - the actual image.

expected - the expected image.

offset - helps decide if the color of two pixels are similar: two pixels that are identical to the human eye may still have slightly different color values. For example, by using an offset of 1 we can indicate that a blue value of 60 is similar to a blue value of 61.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual image is not equal to the expected one.

assertNotEqual

public void assertNotEqual(org.assertj.core.api.AssertionInfo info,
                           BufferedImage actual,
                           BufferedImage other)

Asserts that two images are not equal.

Parameters:

info - contains information about the assertion.

actual - the given image.

other - the object to compare actual to.

Throws:

AssertionError - if actual is equal to other.

assertHasSize

public void assertHasSize(org.assertj.core.api.AssertionInfo info,
                          BufferedImage actual,
                          Dimension size)

Asserts that the size of the given image is equal to the given size.

Parameters:

info - contains information about the assertion.

actual - the given image.

size - the expected size of actual.

Throws:

NullPointerException - if the given size is null.

AssertionError - if the size of the given image is not equal to the given size.