public class

SimpleAtom

extends Object
implements Atom<R>
java.lang.Object
   ↳ android.support.test.espresso.web.model.SimpleAtom

Class Overview

A simple implementation of Atom suitable for subclassing.

Summary

Nested Classes
enum SimpleAtom.ElementReferencePlacement Controls whether the ElementReference appears as the first arg or last arg to the script. 
Public Constructors
SimpleAtom(String script)
Creates a SimpleAtom which runs the given script and places any ElementReference as the first argument to the script.
SimpleAtom(String script, SimpleAtom.ElementReferencePlacement elementPlacement)
Creates a SimpleAtom which runs the given script and places any supplied ElementReference either as the first or last argument to the script.
Public Methods
final List<? extends Object> getArguments(ElementReference elementRef)
The SimpleAtom presents an argument list to the script which follows some basic conventions.
final String getScript()
Returns the script this SimpleAtom was created with.
final Evaluation transform(Evaluation e)
The SimpleAtom's transform method checks the Evaluation object for success.
Protected Methods
List<? extends Object> getNonContextualArguments()
Extend this method to pass additional arguments to the script.
Evaluation handleBadEvaluation(Evaluation e)
Extend this method to handle a failure code in the Evaluation object.
void handleNoElementReference()
Extend this method to handle the case where getArguments() has been called without an ElementReference.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.support.test.espresso.web.model.Atom

Public Constructors

public SimpleAtom (String script)

Creates a SimpleAtom which runs the given script and places any ElementReference as the first argument to the script.

public SimpleAtom (String script, SimpleAtom.ElementReferencePlacement elementPlacement)

Creates a SimpleAtom which runs the given script and places any supplied ElementReference either as the first or last argument to the script.

Public Methods

public final List<? extends Object> getArguments (ElementReference elementRef)

The SimpleAtom presents an argument list to the script which follows some basic conventions. If an ElementReference is provided, it is placed either in the first or last position based on the ElementReferencePlacement provided to the constructor. The nonContextualArguments (if provided via getNonContextualArguments) will appear after the ElementReference.

Parameters
elementRef null unless an ElementReference has been supplied to execute this atom with.
Returns
  • the List of objects to pass to the script as arguments.

public final String getScript ()

Returns the script this SimpleAtom was created with.

public final Evaluation transform (Evaluation e)

The SimpleAtom's transform method checks the Evaluation object for success. If the Evaluation object has an error, the default behaviour is to throw an exception, subclasses may change this behaviour via the handleBadEvaluation method.

Protected Methods

protected List<? extends Object> getNonContextualArguments ()

Extend this method to pass additional arguments to the script.

Returns
  • a list of arguments (non-null)

protected Evaluation handleBadEvaluation (Evaluation e)

Extend this method to handle a failure code in the Evaluation object. The default implementation will throw an exception, subclasses may want to ignore certain failure cases.

Returns
  • Evaluation the evaluation object (must be non-null)
Throws
RuntimeException if the badness level is too high.

protected void handleNoElementReference ()

Extend this method to handle the case where getArguments() has been called without an ElementReference. Implementors may want to throw an exception here if they require an ElementReference to evaluate properly.