com.github.pnavais.machine.api

Class Status

java.lang.Object

com.github.pnavais.machine.api.Status

public class Status
extends Object

The status represents the possible outcome of a given movement between nodes.

Field Summary

Fields

Modifier and Type	Field and Description
static Status	ABORT Abort the operation
protected Message	message The emitted message
static Status	PROCEED Proceed with the operation
static String	STATUS_ABORTED The aborted status keyword
static String	STATUS_FORWARD The send message status keyword
static String	STATUS_PROCEED The proceed status keyword
protected String	statusName The Status name.
protected boolean	valid The validity flag

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Status(String statusName, Message message, boolean validity) Constructor with name, message and validity.

Method Summary

Modifier and Type	Method and Description
static Status	forward(Message message) Creates an status to request the emission of a new message.
boolean	isRedirect() Verify if the status informs of a redirection (forward status and message is present)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_ABORTED

public static final String STATUS_ABORTED

The aborted status keyword

See Also:

Constant Field Values

STATUS_PROCEED

public static final String STATUS_PROCEED

The proceed status keyword

See Also:

Constant Field Values

STATUS_FORWARD

public static final String STATUS_FORWARD

The send message status keyword

See Also:

Constant Field Values

ABORT

public static final Status ABORT

Abort the operation

PROCEED

public static final Status PROCEED

Proceed with the operation

statusName

protected String statusName

The Status name.

message

protected Message message

The emitted message

valid

protected boolean valid

The validity flag

Constructor Detail

Status

protected Status(String statusName,
                 Message message,
                 boolean validity)

Constructor with name, message and validity.

Parameters:

statusName - the status name

message - the message

validity - the validity

Method Detail

forward

public static Status forward(Message message)

Creates an status to request the emission of a new message. It is used to force a change of the target destination due to some custom logic applied.

Parameters:

message - the message

Returns:

the status

isRedirect

public boolean isRedirect()

Verify if the status informs of a redirection (forward status and message is present)

Returns:

tue if redirection needed, false otherwise