com.xatkit.core.platform.action

Class RuntimeAction<T extends RuntimePlatform>

java.lang.Object

com.xatkit.core.platform.action.RuntimeAction<T>

Type Parameters:

T - the concrete RuntimePlatform subclass type containing the action

All Implemented Interfaces:

Callable<RuntimeActionResult>

Direct Known Subclasses:

RestAction, RuntimeArtifactAction

public abstract class RuntimeAction<T extends RuntimePlatform>
extends Object
implements Callable<RuntimeActionResult>

The concrete implementation of an ActionDefinition definition.

A RuntimeAction represents an atomic action that are automatically executed by the ExecutionService component. Instances of this class are created by the associated RuntimePlatform from an input RecognizedIntent.

Note that RuntimeActions implementations must be stored in the action package of their associated concrete RuntimePlatform implementation to enable their automated loading. For example, the action MyAction defined in the platform myPlatformPackage.MyPlatform should be stored in the package myPlatformPackage.action

See Also:

ActionDefinition, ExecutionService, RuntimePlatform

Field Summary

Fields

Modifier and Type	Field and Description
protected T	runtimePlatform The RuntimePlatform subclass containing this action.
protected XatkitSession	session The XatkitSession associated to this action.

Constructor Summary

Constructors

Constructor and Description
RuntimeAction(T runtimePlatform, XatkitSession session) Constructs a new RuntimeAction with the provided runtimePlatform and session.

Method Summary

Modifier and Type	Method and Description
RuntimeActionResult	call() Runs the RuntimeAction and returns its result wrapped in a RuntimeActionResult.
protected abstract Object	compute() The concrete implementation of the RuntimeAction's computation.
XatkitSession	getSession() Returns the XatkitSession used to compute this action.
void	init() A hook method that is called after RuntimeAction.

Methods inherited from class java.lang.Object

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

Field Detail

runtimePlatform

protected T extends RuntimePlatform runtimePlatform

The RuntimePlatform subclass containing this action.

session

protected XatkitSession session

The XatkitSession associated to this action.

Constructor Detail

RuntimeAction

public RuntimeAction(T runtimePlatform,
                     XatkitSession session)

Constructs a new RuntimeAction with the provided runtimePlatform and session.

Parameters:

runtimePlatform - the RuntimePlatform containing this action

session - the XatkitSession associated to this action

Throws:

NullPointerException - if the provided runtimePlatform or session is null

Method Detail

init

public void init()

A hook method that is called after RuntimeAction.

This method can be extended by subclasses to add post-construction computation, such as setting additional fields, checking invariants once the RuntimeAction has been initialized, etc.

call

public RuntimeActionResult call()

Runs the RuntimeAction and returns its result wrapped in a RuntimeActionResult.

This method should not be called manually, and is handled by the ExecutionService component that manages and executes RuntimeActions.

This method does not throw any Exception if the underlying RuntimeAction's computation does not complete. Exceptions thrown during the RuntimeAction's computation can be accessed through the RuntimeActionResult.getThrownException() method.

Specified by:

call in interface Callable<RuntimeActionResult>

Returns:

the RuntimeActionResult containing the raw result of the computation and monitoring information

See Also:

ExecutionService, RuntimeActionResult

getSession

public XatkitSession getSession()

Returns the XatkitSession used to compute this action.

The returned XatkitSession can be different from the one provided in the constructor if the RuntimeAction needs to create a dedicated session. This is for example the case with messaging actions, that typically need to create a session representing the channel to send messages to.

Returns:

the XatkitSession used to compute this action

compute

protected abstract Object compute()
                           throws Exception

The concrete implementation of the RuntimeAction's computation.

This method is internally called by the call() method to perform the raw computation and wrap the results in a RuntimeActionResult. Note that compute() can return raw computation result, and do not have to deal with setting the monitoring information of the created RuntimeActionResult.

This method should be overriden by subclasses to implement the RuntimeAction's computation logic.

Returns:

the raw result of the RuntimeAction's computation

Throws:

Exception - if an error occurred when computing the RuntimeAction