com.atlassian.selenium.visualcomparison

Class VisualComparer

java.lang.Object

com.atlassian.selenium.visualcomparison.VisualComparer

@Internal
public class VisualComparer
extends Object

Implements the visual comparison functionality.

NOTE: this class is considered internal as of 2.3 and may be subject to API changes and removal as of 3.0. Please use Comparer and the associated family of classes making up the Visual Comparison V2 API instead of this class directly.

Constructor Summary

Constructors

Constructor and Description
VisualComparer(VisualComparableClient client)

Method Summary

Modifier and Type	Method and Description
void	assertUIMatches(String id, String baselineImagePath)
boolean	compareScreenshots(ArrayList<Screenshot> oldScreenshots, ArrayList<Screenshot> newScreenshots)
void	disableReportGeneration()
void	enableReportGeneration(String reportOutputPath)
List<BoundingBox>	getIgnoreAreas()
boolean	getIgnoreSingleLineDiffs()
boolean	getRefreshAfterResize()
ScreenResolution[]	getScreenResolutions()
ScreenshotDiff	getScreenshotDiff(Screenshot oldScreenshot, Screenshot newScreenshot)
String	getTempPath()
Map<String,String>	getUIStringReplacements()
long	getWaitforJQueryTimeout()
ArrayList<Screenshot>	loadBaselineScreenshots(String id, String baselineImagePath)
protected void	replaceUIHtml(String id, String newContent)
void	setIgnoreAreas(List<BoundingBox> ignoreAreas)
void	setIgnoreSingleLineDiffs(boolean ignoreSingleLineDiffs)
void	setRefreshAfterResize(boolean refreshAfterResize)
void	setScreenResolutions(ScreenResolution[] resolutions)
void	setTempPath(String tempPath)
void	setUIStringReplacements(Map<String,String> uiStringReplacements)
void	setWaitforJQueryTimeout(long waitforJQueryTimeout)
ArrayList<Screenshot>	takeScreenshots(String id)
boolean	uiMatches(String id, String baselineImagePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualComparer

public VisualComparer(VisualComparableClient client)

Method Detail

getWaitforJQueryTimeout

public long getWaitforJQueryTimeout()

setWaitforJQueryTimeout

public void setWaitforJQueryTimeout(long waitforJQueryTimeout)

setScreenResolutions

public void setScreenResolutions(ScreenResolution[] resolutions)

getScreenResolutions

public ScreenResolution[] getScreenResolutions()

setRefreshAfterResize

public void setRefreshAfterResize(boolean refreshAfterResize)

getRefreshAfterResize

public boolean getRefreshAfterResize()

setUIStringReplacements

public void setUIStringReplacements(Map<String,String> uiStringReplacements)

getUIStringReplacements

public Map<String,String> getUIStringReplacements()

enableReportGeneration

public void enableReportGeneration(String reportOutputPath)

disableReportGeneration

public void disableReportGeneration()

setTempPath

public void setTempPath(String tempPath)

getTempPath

public String getTempPath()

getIgnoreAreas

public List<BoundingBox> getIgnoreAreas()

getIgnoreSingleLineDiffs

public boolean getIgnoreSingleLineDiffs()

setIgnoreSingleLineDiffs

public void setIgnoreSingleLineDiffs(boolean ignoreSingleLineDiffs)

setIgnoreAreas

public void setIgnoreAreas(List<BoundingBox> ignoreAreas)

assertUIMatches

public void assertUIMatches(String id,
                            String baselineImagePath)

uiMatches

public boolean uiMatches(String id,
                         String baselineImagePath)
                  throws Exception

Throws:

Exception

takeScreenshots

public ArrayList<Screenshot> takeScreenshots(String id)
                                      throws IOException

Throws:

IOException

loadBaselineScreenshots

public ArrayList<Screenshot> loadBaselineScreenshots(String id,
                                                     String baselineImagePath)
                                              throws IOException

Throws:

IOException

replaceUIHtml

protected void replaceUIHtml(String id,
                             String newContent)

compareScreenshots

public boolean compareScreenshots(ArrayList<Screenshot> oldScreenshots,
                                  ArrayList<Screenshot> newScreenshots)
                           throws Exception

Throws:

Exception

getScreenshotDiff

public ScreenshotDiff getScreenshotDiff(Screenshot oldScreenshot,
                                        Screenshot newScreenshot)
                                 throws Exception

Throws:

Exception