SimpleAtom
public
class
SimpleAtom
extends Object
implements
Atom<Evaluation>
java.lang.Object | |
↳ | android.support.test.espresso.web.model.SimpleAtom |
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<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<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. |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.support.test.espresso.web.model.Atom
|
Public constructors
SimpleAtom
SimpleAtom (String script)
Creates a SimpleAtom which runs the given script and places any ElementReference as the first argument to the script.
Parameters | |
---|---|
script |
String |
SimpleAtom
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.
Parameters | |
---|---|
script |
String |
elementPlacement |
SimpleAtom.ElementReferencePlacement |
Public methods
getArguments
List<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 |
ElementReference : null unless an ElementReference has been supplied to execute this atom
with. |
Returns | |
---|---|
List<Object> |
the List of objects to pass to the script as arguments. |
transform
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.
Parameters | |
---|---|
e |
Evaluation |
Returns | |
---|---|
Evaluation |
Protected methods
getNonContextualArguments
List<Object> getNonContextualArguments ()
Extend this method to pass additional arguments to the script.
Returns | |
---|---|
List<Object> |
a list of arguments (non-null) |
handleBadEvaluation
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.
Parameters | |
---|---|
e |
Evaluation |
Returns | |
---|---|
Evaluation |
Evaluation the evaluation object (must be non-null) |
Throws | |
---|---|
RuntimeException |
if the badness level is too high. |
handleNoElementReference
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.