de.nenick.espressomacchiato.tools

Class EspScreenshotTool

java.lang.Object

de.nenick.espressomacchiato.tools.EspScreenshotTool

public class EspScreenshotTool
extends java.lang.Object

Tools for taking and comparing screenshots.

Field Summary

Fields

Modifier and Type	Field and Description
static double	COMPARE_DELTA_FULL_IDENTICAL Use to assume full equality when comparing screenshots.
static double	COMPARE_DELTA_TIME_CHANGE Use to ignore time changes when comparing screenshots.
static java.lang.String	screenshotFolderName This folder will be created in your application data to store screenshots.

Constructor Summary

Constructors

Constructor and Description
EspScreenshotTool()

Method Summary

Modifier and Type	Method and Description
static double	comparePercentage(java.lang.String referenceImage, java.lang.String comparedImage) Calculate percentage match of two images.
protected android.content.Context	getTargetContext()
java.lang.String	obtainScreenshotDirectory()
static java.io.File	screenshotLocation(java.lang.String pictureName)
java.io.File	screenshotLocationInternal(java.lang.String pictureName)
static void	takeWithName(java.lang.String name)
protected void	takeWithNameInternal(java.lang.String name)
protected void	throwIfUiAutomatorNotExist()

Methods inherited from class java.lang.Object

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

Field Detail

COMPARE_DELTA_FULL_IDENTICAL

public static final double COMPARE_DELTA_FULL_IDENTICAL

Use to assume full equality when comparing screenshots.

See Also:

Constant Field Values

COMPARE_DELTA_TIME_CHANGE

public static final double COMPARE_DELTA_TIME_CHANGE

Use to ignore time changes when comparing screenshots.

Actionbar contains a time which must be ignored.

See Also:

Constant Field Values

screenshotFolderName

public static java.lang.String screenshotFolderName

This folder will be created in your application data to store screenshots.

You can change the name to your needs.

Constructor Detail

EspScreenshotTool

public EspScreenshotTool()

Method Detail

takeWithName

public static void takeWithName(java.lang.String name)

takeWithNameInternal

protected void takeWithNameInternal(java.lang.String name)

throwIfUiAutomatorNotExist

protected void throwIfUiAutomatorNotExist()
                                   throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

obtainScreenshotDirectory

public java.lang.String obtainScreenshotDirectory()

getTargetContext

protected android.content.Context getTargetContext()

comparePercentage

public static double comparePercentage(java.lang.String referenceImage,
                                       java.lang.String comparedImage)

Calculate percentage match of two images.

Comparing images only works if both images have identical dimensions. When to images are full identical then you get 100.0 percentage match else an value below of it.

Parameters:

referenceImage - Absolute path of the reference image.

comparedImage - Absolute path of the image which should be compared with the referenceImage.

Returns:

Percentage match of comparedImage to the referenceImage. A value from 0.0 to 100.0 percentage.

screenshotLocation

public static java.io.File screenshotLocation(java.lang.String pictureName)

screenshotLocationInternal

public java.io.File screenshotLocationInternal(java.lang.String pictureName)