com.applitools.eyes.positioning

Class InvalidPositionProvider

java.lang.Object

com.applitools.eyes.positioning.InvalidPositionProvider

All Implemented Interfaces:

PositionProvider

public class InvalidPositionProvider
extends Object
implements PositionProvider

An implementation of PositionProvider which throws an exception for every method. Can be used as a placeholder until an actual implementation is set.

Constructor Summary

Constructors

Constructor and Description
InvalidPositionProvider()

Method Summary

Modifier and Type	Method and Description
Location	getCurrentPosition()
RectangleSize	getEntireSize()
PositionMemento	getState() Get the current state of the position provider.
void	restoreState(PositionMemento state) Restores the state of the position provider to the state provided as a parameter.
Location	setPosition(Location location) Go to the specified location.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidPositionProvider

public InvalidPositionProvider()

Method Detail

getCurrentPosition

public Location getCurrentPosition()

Specified by:

getCurrentPosition in interface PositionProvider

Returns:

The current position, or null if position is not available.

setPosition

public Location setPosition(Location location)

Description copied from interface: PositionProvider

Go to the specified location.

Specified by:

setPosition in interface PositionProvider

Parameters:

location - The position to set.

getEntireSize

public RectangleSize getEntireSize()

Specified by:

getEntireSize in interface PositionProvider

Returns:

The entire size of the container which the position is relative to.

getState

public PositionMemento getState()

Description copied from interface: PositionProvider

Get the current state of the position provider. This is different from PositionProvider.getCurrentPosition() in that the state of the position provider might include other model than just the coordinates. For example a CSS translation based position provider (in WebDriver based SDKs), might save the entire "transform" style value as its state.

Specified by:

getState in interface PositionProvider

Returns:

The current state of the position provider, which can later be restored by passing it as a parameter to PositionProvider.restoreState(com.applitools.eyes.positioning.PositionMemento).

restoreState

public void restoreState(PositionMemento state)

Description copied from interface: PositionProvider

Restores the state of the position provider to the state provided as a parameter.

Specified by:

restoreState in interface PositionProvider

Parameters:

state - The state to restore to.