com.applitools.eyes

Class ResponseTimeAlgorithm

java.lang.Object

com.applitools.eyes.ResponseTimeAlgorithm

public class ResponseTimeAlgorithm
extends Object

A container for the algorithm for window timing tests.

Constructor Summary

Constructors

Constructor and Description
ResponseTimeAlgorithm()

Method Summary

Modifier and Type	Method and Description
static com.applitools.eyes.MatchWindowDataWithScreenshot	cloneTimedMWDWSWithPrimary(com.applitools.eyes.MatchWindowDataWithScreenshot currentMwdws, boolean updatePrimary) Clones the given MatchWindowDataWithScreenshot instance, while setting the primary to the required value.
static String	createTagForDeadline(int deadline, long elapsedTime) Creates a string describing the elapsed time relative to a deadline.
static int	findEarliestMatchIndex(Logger logger, com.applitools.eyes.ServerConnector serverConnector, com.applitools.eyes.RunningSession runningSession, List<com.applitools.eyes.MatchWindowDataWithScreenshot> collectedData, com.applitools.eyes.MatchWindowDataWithScreenshot theMatch, com.applitools.eyes.MatchWindowDataWithScreenshot lastNonMatch) Find the EARLIEST match within the collected data.
static ResponseTimeInitialMatchSearchResult	responseTimeInitialMatchSearch(Logger logger, com.applitools.eyes.ServerConnector serverConnector, com.applitools.eyes.RunningSession runningSession, AppOutputProvider appOutputProvider, com.applitools.eyes.RegionProvider regionProvider, long startTime, int deadline, int timeout, long matchInterval, List<com.applitools.eyes.MatchWindowDataWithScreenshot> collectedData) Performs an initial search for a match.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseTimeAlgorithm

public ResponseTimeAlgorithm()

Method Detail

createTagForDeadline

public static String createTagForDeadline(int deadline,
                                          long elapsedTime)

Creates a string describing the elapsed time relative to a deadline.

Parameters:

deadline - The deadline to be used as reference. (Seconds)

elapsedTime - The elapsed time to describe. (Second)

Returns:

A tag describing the elapsed time, with reference to the deadline.

cloneTimedMWDWSWithPrimary

public static com.applitools.eyes.MatchWindowDataWithScreenshot cloneTimedMWDWSWithPrimary(com.applitools.eyes.MatchWindowDataWithScreenshot currentMwdws,
                                                                                           boolean updatePrimary)

Clones the given MatchWindowDataWithScreenshot instance, while setting the primary to the required value.

Parameters:

currentMwdws - The instance to clone.

updatePrimary - The primary value to set.

Returns:

A new instance with the updated primary value.

responseTimeInitialMatchSearch

public static ResponseTimeInitialMatchSearchResult responseTimeInitialMatchSearch(Logger logger,
                                                                                  com.applitools.eyes.ServerConnector serverConnector,
                                                                                  com.applitools.eyes.RunningSession runningSession,
                                                                                  AppOutputProvider appOutputProvider,
                                                                                  com.applitools.eyes.RegionProvider regionProvider,
                                                                                  long startTime,
                                                                                  int deadline,
                                                                                  int timeout,
                                                                                  long matchInterval,
                                                                                  List<com.applitools.eyes.MatchWindowDataWithScreenshot> collectedData)

Performs an initial search for a match. Notice that this means this function does NOT try to find the EARLIEST match, but to find ANY match. It does so by taking screenshots at some interval, and performing the match on a different thread. It is done that way because the matching process is much slower than screenshot taking.

Parameters:

logger - The logger to use.

serverConnector - The server connector to use for the matching.

runningSession - The current session in which we perform the matching.

appOutputProvider - A provider which enables us to capture a screenshot.

regionProvider - Which part of the screenshot we wish to compare.

startTime - The start time for the test. should be the result of a call to System.currentTimeMillis().

deadline - The expected time by which the application should have been loaded. (Seconds)

timeout - The maximum time waiting for the application to load. (Seconds)

matchInterval - The interval between performing matches.

collectedData - A container in which we will store all the captured screenshots.

Returns:

The result of the initial search.

findEarliestMatchIndex

public static int findEarliestMatchIndex(Logger logger,
                                         com.applitools.eyes.ServerConnector serverConnector,
                                         com.applitools.eyes.RunningSession runningSession,
                                         List<com.applitools.eyes.MatchWindowDataWithScreenshot> collectedData,
                                         com.applitools.eyes.MatchWindowDataWithScreenshot theMatch,
                                         com.applitools.eyes.MatchWindowDataWithScreenshot lastNonMatch)

Find the EARLIEST match within the collected data.

Parameters:

logger - The logger to use.

serverConnector - The server connector to use for the matching.

runningSession - The current session in which we perform the matching.

collectedData - The list of captured screenshots in which to search for a match.

theMatch - The match data of the currently known successful match, or null if no match is known.

lastNonMatch - The match data of the last known failed match, or null if no such failed match is known.

Returns:

The index of earliest match found.