com.xatkit.core.platform.action

Class RuntimeMessageAction<T extends RuntimePlatform>

java.lang.Object

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

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

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

Type Parameters:

T - the concrete RuntimePlatform subclass type containing the action

All Implemented Interfaces:

Callable<RuntimeActionResult>

public abstract class RuntimeMessageAction<T extends RuntimePlatform>
extends RuntimeArtifactAction<T>

An abstract RuntimeAction processing a message.

This class takes a String message as its constructor parameter, and relies on RuntimeContexts#fillContextValues(String) to pre-process it and replace context variable accesses by their concrete value.

This class is only responsible of the pre-processing of the provided message, and does not provide any method to print it to the end user.

See Also:

RuntimePlatform, RuntimeContexts

Field Summary

Fields

Modifier and Type	Field and Description
protected String	message The processed message.

Fields inherited from class com.xatkit.core.platform.action.RuntimeArtifactAction

DEFAULT_MESSAGE_DELAY, MESSAGE_DELAY_KEY

Fields inherited from class com.xatkit.core.platform.action.RuntimeAction

runtimePlatform, session

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected String	getMessage() Returns the processed message.

Methods inherited from class com.xatkit.core.platform.action.RuntimeArtifactAction

beforeDelay, call, getClientSession, init

Methods inherited from class com.xatkit.core.platform.action.RuntimeAction

compute, getSession

Methods inherited from class java.lang.Object

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

Field Detail

message

protected String message

The processed message.

This attribute is the result of calling RuntimeContexts#fillContextValues(String) on the rawMessage constructor parameter. Concrete subclasses can use this attribute to print the processed message to the end user.

See Also:

RuntimeContexts#fillContextValues(String), getMessage()

Constructor Detail

RuntimeMessageAction

public RuntimeMessageAction(T runtimePlatform,
                            XatkitSession session,
                            String rawMessage)

Constructs a new RuntimeMessageAction with the provided runtimePlatform, session, and rawMessage.

This constructor stores the result of calling RuntimeContexts#fillContextValues(String) on the rawMessage parameter. Concreted subclasses can use this attribute to print the processed message to the end user.

Parameters:

runtimePlatform - the RuntimePlatform containing this action

session - the XatkitSession associated to this action

rawMessage - the message to process

Throws:

NullPointerException - if the provided runtimePlatform or session is null

IllegalArgumentException - if the provided rawMessage is null or empty

See Also:

XatkitSession, RuntimeContexts

Method Detail

getMessage

protected String getMessage()

Returns the processed message.

Returns:

the processed message