org.voltdb.task

Class Action

java.lang.Object

org.voltdb.task.Action

public final class Action
extends java.lang.Object

Class which defines an action to be taken as well as a callback to be invoked when that action has been performed. There is no callback present if the type of action is a stop action.

Method Summary

Modifier and Type	Method and Description
static Action	callback(java.util.function.Function<ActionResult,Action> callback) Create an Action which causes the callback to be invoked.
static Action	error(java.lang.String statusMessage) Create an Action which indicates that an unrecoverable error has occurred and the scheduler must exit.
static Action	exit(java.lang.String statusMessage) Create an Action which indicates that the scheduler has reached the end of its life cycle gracefully
java.util.function.Function<ActionResult,Action>	getCallback()
java.lang.String	getProcedure()
java.lang.Object[]	getProcedureParameters()
java.lang.String	getStatusMessage()
ActionType	getType()
static Action	procedureCall(java.util.function.Function<ActionResult,Action> callback, java.lang.String procedure, java.lang.Object... procedureParameters) Create an Action which executes a procedure with given parameters
Action	setStatusMessage(java.lang.String statusMessage) Set the optional status massage which will be reported in the statistics for a task and if this is an ActionType.ERROR or ActionType.EXIT action then it will also be logged.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

error

public static Action error(java.lang.String statusMessage)

Create an Action which indicates that an unrecoverable error has occurred and the scheduler must exit.

statusMessage is the same status message which is set by calling setStatusMessage(String)

Parameters:

statusMessage - To log indicating the details of the error. May be null

Returns:

A new ActionType.ERROR instance of Action

exit

public static Action exit(java.lang.String statusMessage)

Create an Action which indicates that the scheduler has reached the end of its life cycle gracefully

statusMessage is the same status message which is set by calling setStatusMessage(String)

Parameters:

statusMessage - To log indicating the details of the error. May be null

Returns:

A new ActionType.EXIT instance of Action

procedureCall

public static Action procedureCall(java.util.function.Function<ActionResult,Action> callback,
                                   java.lang.String procedure,
                                   java.lang.Object... procedureParameters)

Create an Action which executes a procedure with given parameters

Parameters:

callback - To be invoked after this procedure is executed

procedure - Name of procedure to execute

procedureParameters - That are passed to procedure for execution

Returns:

A new ActionType.PROCEDURE instance of Action

callback

public static Action callback(java.util.function.Function<ActionResult,Action> callback)

Create an Action which causes the callback to be invoked. An ActionResult will be associated with this call however it will have a null procedure and result.

Parameters:

callback - To be invoked for this action

Returns:

A new ActionType.CALLBACK instance of Action

setStatusMessage

public Action setStatusMessage(java.lang.String statusMessage)

Set the optional status massage which will be reported in the statistics for a task and if this is an ActionType.ERROR or ActionType.EXIT action then it will also be logged. For ActionType.ERROR or ActionType.EXIT actions this can be provided as part of the factory method.

Parameters:

statusMessage - To be reported

Returns:

this

getCallback

public java.util.function.Function<ActionResult,Action> getCallback()

Returns:

callback to be invoked after any provided procedure is executed. Will be null if the type of action is a stop action

toString

public java.lang.String toString()

getType

public ActionType getType()

Returns:

The ActionType of this action

getStatusMessage

public java.lang.String getStatusMessage()

Returns:

Optional status message provided with any action

getProcedure

public java.lang.String getProcedure()

Returns:

Name of procedure to execute. Will be null if this is not a ActionType.PROCEDURE

getProcedureParameters

public java.lang.Object[] getProcedureParameters()

Returns:

The parameters that are to be passed the the procedure returned by getProcedure()