com.applitools.eyes

Class MatchWindowData.Options

java.lang.Object

com.applitools.eyes.MatchWindowData.Options

Enclosing class:

MatchWindowData

public static class MatchWindowData.Options
extends Object

Encapsulates the "Options" section of the MatchExpectedOutput body model.

Constructor Summary

Constructors

Constructor and Description
Options(String name, Trigger[] userInputs, boolean replaceLast, boolean ignoreMismatch, boolean ignoreMatch, boolean forceMismatch, boolean forceMatch, ImageMatchSettings imageMatchSettings, String source, String variantId, String renderId)

Method Summary

Modifier and Type	Method and Description
boolean	getForceMatch()
boolean	getForceMismatch()
boolean	getIgnoreMatch()
boolean	getIgnoreMismatch()
ImageMatchSettings	getImageMatchSettings()
String	getName()
String	getRenderId()
boolean	getReplaceLast()
String	getSource()
Trigger[]	getUserInputs()
String	getVariantId()

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(String name,
               Trigger[] userInputs,
               boolean replaceLast,
               boolean ignoreMismatch,
               boolean ignoreMatch,
               boolean forceMismatch,
               boolean forceMatch,
               ImageMatchSettings imageMatchSettings,
               String source,
               String variantId,
               String renderId)

Parameters:

name - The tag of the window to be matched.

userInputs - A list of triggers between the previous matchWindow call and the current matchWindow call. Can be array of size 0, but MUST NOT be null.

ignoreMismatch - Tells the server whether or not to store a mismatch for the current window as window in the session.

ignoreMatch - Tells the server whether or not to store a match for the current window as window in the session.

forceMismatch - Forces the server to skip the comparison process and mark the current window as a mismatch.

forceMatch - Forces the server to skip the comparison process and mark the current window as a match.

imageMatchSettings - Settings specifying how the server should compare the image.

Method Detail

getName

public String getName()

getUserInputs

public Trigger[] getUserInputs()

getReplaceLast

public boolean getReplaceLast()

getIgnoreMismatch

public boolean getIgnoreMismatch()

getIgnoreMatch

public boolean getIgnoreMatch()

getForceMismatch

public boolean getForceMismatch()

getForceMatch

public boolean getForceMatch()

getImageMatchSettings

public ImageMatchSettings getImageMatchSettings()

getSource

public String getSource()

getRenderId

public String getRenderId()

getVariantId

public String getVariantId()