com.applitools.eyes

Class ImageMatchSettings

java.lang.Object

com.applitools.eyes.ImageMatchSettings

public class ImageMatchSettings
extends Object

Encapsulates match settings for the a session.

Constructor Summary

Constructors

Constructor and Description
ImageMatchSettings() See ImageMatchSettings(MatchLevel, ExactMatchSettings).
ImageMatchSettings(MatchLevel matchLevel, ExactMatchSettings exact)

Method Summary

Modifier and Type	Method and Description
ExactMatchSettings	getExact()
FloatingMatchSettings[]	getFloatingRegions() Returns an array of floating regions.
Boolean	getIgnoreCaret()
Region[]	getIgnoreRegions() Returns the array of regions to ignore.
MatchLevel	getMatchLevel()
void	setExact(ExactMatchSettings exact)
void	setFloatingRegions(FloatingMatchSettings[] floatingRegions) Sets an array of floating regions.
void	setIgnoreCaret(Boolean ignoreCaret)
void	setIgnoreRegions(Region[] ignoreRegions) Sets an array of regions to ignore.
void	setMatchLevel(MatchLevel matchLevel)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMatchSettings

public ImageMatchSettings(MatchLevel matchLevel,
                          ExactMatchSettings exact)

ImageMatchSettings

public ImageMatchSettings()

See ImageMatchSettings(MatchLevel, ExactMatchSettings). matchLevel defaults to STRICT, exact defaults to null.

Method Detail

getMatchLevel

public MatchLevel getMatchLevel()

Returns:

The "strictness" level of the match.

setMatchLevel

public void setMatchLevel(MatchLevel matchLevel)

Parameters:

matchLevel - The "strictness" level of the match.

getExact

public ExactMatchSettings getExact()

Returns:

The parameters for the "Exact" match settings.

setExact

public void setExact(ExactMatchSettings exact)

Parameters:

exact - The parameters for the "exact" match settings.

getIgnoreCaret

public Boolean getIgnoreCaret()

Returns:

The parameters for the "IgnoreCaret" match settings.

setIgnoreRegions

public void setIgnoreRegions(Region[] ignoreRegions)

Sets an array of regions to ignore.

Parameters:

ignoreRegions - The array of regions to ignore.

getIgnoreRegions

public Region[] getIgnoreRegions()

Returns the array of regions to ignore.

Returns:

the array of regions to ignore.

setFloatingRegions

public void setFloatingRegions(FloatingMatchSettings[] floatingRegions)

Sets an array of floating regions.

Parameters:

floatingRegions - The array of floating regions.

getFloatingRegions

public FloatingMatchSettings[] getFloatingRegions()

Returns an array of floating regions.

Returns:

an array of floating regions.

setIgnoreCaret

public void setIgnoreCaret(Boolean ignoreCaret)

Parameters:

ignoreCaret - The parameters for the "ignoreCaret" match settings.

toString

public String toString()

Overrides:

toString in class Object