com.assertthat.selenium_shutterbug.core

Class Snapshot<T extends Snapshot>

java.lang.Object

com.assertthat.selenium_shutterbug.core.Snapshot<T>

Direct Known Subclasses:

ElementSnapshot, PageSnapshot

public abstract class Snapshot<T extends Snapshot>
extends Object

Created by Glib_Briia on 17/06/2016.

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferedImage	image

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
boolean	equals(BufferedImage image)
boolean	equals(BufferedImage image, double deviation)
boolean	equals(Object o)
boolean	equals(Snapshot other, double deviation)
boolean	equals(String path)
boolean	equals(String path, double deviation)
boolean	equalsWithDiff(BufferedImage image, String resultingImagePath)
boolean	equalsWithDiff(BufferedImage image, String resultingImagePath, double deviation)
boolean	equalsWithDiff(Snapshot image, String resultingImagePath)
boolean	equalsWithDiff(Snapshot image, String resultingImagePath, double deviation)
boolean	equalsWithDiff(String path, String resultingImagePath)
boolean	equalsWithDiff(String path, String resultingImagePath, double deviation)
byte[]	getBytes()
BufferedImage	getImage()
int	hashCode()
T	monochrome() Apply gray-and-white filter to the image.
void	save() Final method to be called in the chain.
void	save(String path) Final method to be called in the chain.
protected abstract T	self()
protected void	setImage(BufferedImage image)
T	withCroppedThumbnail(double scale, double cropWidth, double cropHeight) Generate cropped thumbnail of the original screenshot.
T	withCroppedThumbnail(double scale, int maxWidth, int maxHeight) Generate cropped thumbnail of the original screenshot.
T	withCroppedThumbnail(String path, String name, double scale, double cropWidth, double cropHeight) Generate cropped thumbnail of the original screenshot.
T	withCroppedThumbnail(String path, String name, double scale, int maxWidth, int maxHeight) Generate cropped thumbnail of the original screenshot.
T	withName(String name)
T	withThumbnail(double scale) Generate a thumbnail of the original screenshot.
T	withThumbnail(Path path, String name, double scale) Generate a thumbnail of the original screenshot.
T	withThumbnail(String path, String name, double scale) Generate a thumbnail of the original screenshot.
T	withTitle(String title)

Methods inherited from class java.lang.Object

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

Field Detail

image

protected BufferedImage image

Constructor Detail

Snapshot

public Snapshot()

Method Detail

self

protected abstract T self()

withName

public T withName(String name)

Parameters:

name - file name of the resulted image by default will be timestamp in format: 'yyyy_MM_dd_HH_mm_ss_SSS'.

Returns:

instance of type Snapshot

withTitle

public T withTitle(String title)

Parameters:

title - title of the resulted image. Won't be assigned by default.

Returns:

instance of type Snapshot

withThumbnail

public T withThumbnail(String path,
                       String name,
                       double scale)

Generate a thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

path - to save thumbnail image to

name - of the resulting image

scale - to apply

Returns:

instance of type Snapshot

withCroppedThumbnail

public T withCroppedThumbnail(String path,
                              String name,
                              double scale,
                              double cropWidth,
                              double cropHeight)

Generate cropped thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

path - to save thumbnail image to

name - of the resulting image

scale - to apply

cropWidth - e.g. 0.2 will leave 20% of the initial width

cropHeight - e.g. 0.1 will leave 10% of the initial width

Returns:

instance of type Snapshot

withCroppedThumbnail

public T withCroppedThumbnail(String path,
                              String name,
                              double scale,
                              int maxWidth,
                              int maxHeight)

Generate cropped thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

path - to save thumbnail image to

name - of the resulting image

scale - to apply

maxWidth - max width in pixels. If set to -1 the actual image width is used

maxHeight - max height in pixels. If set to -1 the actual image height is used

Returns:

instance of type Snapshot

withCroppedThumbnail

public T withCroppedThumbnail(double scale,
                              double cropWidth,
                              double cropHeight)

Generate cropped thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

scale - to apply

cropWidth - e.g. 0.2 will leave 20% of the initial width

cropHeight - e.g. 0.1 will leave 10% of the initial width

Returns:

instance of type Snapshot

withCroppedThumbnail

public T withCroppedThumbnail(double scale,
                              int maxWidth,
                              int maxHeight)

Generate cropped thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

scale - to apply

maxWidth - max width in pixels. If set to -1 the actual image width is used

maxHeight - max height in pixels. If set to -1 the actual image height is used

Returns:

instance of type Snapshot

withThumbnail

public T withThumbnail(Path path,
                       String name,
                       double scale)

Generate a thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

path - to save thumbnail image to

name - of the resulting image

scale - to apply

Returns:

instance of type Snapshot

withThumbnail

public T withThumbnail(double scale)

Generate a thumbnail of the original screenshot. Will save different thumbnails depends on when it was called in the chain.

Parameters:

scale - to apply

Returns:

instance of type Snapshot

monochrome

public T monochrome()

Apply gray-and-white filter to the image.

Returns:

instance of type Snapshot

getImage

public BufferedImage getImage()

Returns:

BufferedImage - current image being processed.

getBytes

public byte[] getBytes()
                throws IOException

Returns:

byte[] - byte array representation of the image.

Throws:

IOException

setImage

protected void setImage(BufferedImage image)

save

public void save()

Final method to be called in the chain. Actually saves processed image to the default location: ./screenshots

save

public void save(String path)

Final method to be called in the chain. Actually saves processed image to the specified path.

Parameters:

path - to save image to

equals

public boolean equals(Snapshot other,
                      double deviation)

Parameters:

other - Snapshot to compare with

deviation - allowed deviation while comparing.

Returns:

true if the the percentage of differences between current image and provided one is less than or equal to deviation

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Parameters:

o - Object to compare with

Returns:

true if the the provided object is of type Snapshot and images are strictly equal.

equals

public boolean equals(BufferedImage image)

Parameters:

image - BufferedImage to compare with.

Returns:

true if the the provided image and current image are strictly equal.

equals

public boolean equals(String path)
               throws IOException

Parameters:

path - path to image to compare to.

Returns:

true if the the provided image and current image are strictly equal.

Throws:

IOException - if unable to read image from path

equals

public boolean equals(BufferedImage image,
                      double deviation)

Parameters:

image - BufferedImage to compare with.

deviation - allowed deviation while comparing.

Returns:

true if the the percentage of differences between current image and provided one is less than or equal to deviation

equals

public boolean equals(String path,
                      double deviation)
               throws IOException

Parameters:

path - path to image to compare to.

deviation - allowed deviation while comparing.

Returns:

true if the the percentage of differences between current image and provided one is less than or equal to deviation

Throws:

IOException - if unable to read image from path

equalsWithDiff

public boolean equalsWithDiff(BufferedImage image,
                              String resultingImagePath)

Parameters:

image - BufferedImage to compare with.

resultingImagePath - path with name to save to resulting images with diff

Returns:

true if the the provided image and current image are strictly equal.

equalsWithDiff

public boolean equalsWithDiff(BufferedImage image,
                              String resultingImagePath,
                              double deviation)

Parameters:

image - BufferedImage to compare with.

resultingImagePath - path with name to save to resulting images with diff

deviation - allowed deviation while comparing

Returns:

true if the the provided image and current image are strictly equal.

equalsWithDiff

public boolean equalsWithDiff(Snapshot image,
                              String resultingImagePath)

Parameters:

image - Snapshot to compare with.

resultingImagePath - path with name to save to resulting images with diff

Returns:

true if the the provided image and current image are strictly equal.

equalsWithDiff

public boolean equalsWithDiff(Snapshot image,
                              String resultingImagePath,
                              double deviation)

Parameters:

image - Snapshot to compare with.

resultingImagePath - path with name to save to resulting images with diff

deviation - allowed deviation while comparing

Returns:

true if the the provided image and current image are strictly equal.

equalsWithDiff

public boolean equalsWithDiff(String path,
                              String resultingImagePath)
                       throws IOException

Parameters:

path - path to image to compare to

resultingImagePath - path with name to save to resulting images with diff

Returns:

true if the the provided image and current image are strictly equal.

Throws:

IOException - if unable to read image from path

equalsWithDiff

public boolean equalsWithDiff(String path,
                              String resultingImagePath,
                              double deviation)
                       throws IOException

Parameters:

path - BufferedImage to compare with.

resultingImagePath - path with name to save to resulting images with diff

deviation - allowed deviation while comparing

Returns:

true if the the provided image and current image are strictly equal.

Throws:

IOException - if unable to read image from path

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

image hash code