SimpleAtom

public class SimpleAtom implements Atom

A simple implementation of Atom suitable for subclassing.

Summary

Nested types

Controls whether the ElementReference appears as the first arg or last arg to the script.

Public fields
final String

Public constructors

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>

The SimpleAtom presents an argument list to the script which follows some basic conventions.
final String

Returns the script this SimpleAtom was created with.
final Evaluation

The SimpleAtom's transform method checks the Evaluation object for success.

Protected methods
List<Object>

Extend this method to pass additional arguments to the script.
Evaluation

Extend this method to handle a failure code in the Evaluation object.
void

Extend this method to handle the case where getArguments() has been called without an ElementReference.

Public fields

script

public final String script

Public constructors

SimpleAtom

public SimpleAtom(String script)

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

SimpleAtom

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

getArguments

public final List<Object> getArguments(@Nullable 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.

getScript

public final String getScript()

Returns the script this SimpleAtom was created with.

transform

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

getNonContextualArguments

protected List<Object> getNonContextualArguments()

Extend this method to pass additional arguments to the script.

Returns
List<Object>

a list of arguments (non-null)

handleBadEvaluation

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

Evaluation the evaluation object (must be non-null)
Throws
java.lang.RuntimeException java.lang.RuntimeException

if the badness level is too high.

handleNoElementReference

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.