org.jacpfx.api.message

Interface Message<A,M>

Type Parameters:

M - defines the type of message

A - defines the type of ActionEvent

All Superinterfaces:

java.lang.Cloneable

public interface Message<A,M>
extends java.lang.Cloneable

Represents an message used by specific listener. An message targets a component and contains a message body; every target get a specific instance of an message (cloneMessage) containing only his specific message body and message event.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
Message<A,M>	cloneMessage() Clone message and containing event.
M	getMessageBody() Get the message payload.
A	getSourceEvent() Get source of this message event.
java.lang.String	getSourceId() Get the caller id.
java.lang.String	getTargetId() Returns message target id.
<T> T	getTypedMessageBody(java.lang.Class<T> clazz) Returns a typed message, if applicable.
<T> boolean	isMessageBodyTypeOf(java.lang.Class<T> clazz) Checks if message is type of a given class.
boolean	messageBodyEquals(java.lang.Object object) Check if message equals given input.

Method Detail

getMessageBody

M getMessageBody()

Get the message payload.

Returns:

M returns the message object

getSourceId

java.lang.String getSourceId()

Get the caller id.

Returns:

the source id

getSourceEvent

A getSourceEvent()

Get source of this message event.

Returns:

the event

cloneMessage

Message<A,M> cloneMessage()

Clone message and containing event.

Returns:

a cloneMessage of current message instance

getTargetId

java.lang.String getTargetId()

Returns message target id.

Returns:

the target id

isMessageBodyTypeOf

<T> boolean isMessageBodyTypeOf(java.lang.Class<T> clazz)

Checks if message is type of a given class.

Parameters:

clazz, - class to check if message is equal to

, - the generic type

Returns:

true if message body type equals clazz

getTypedMessageBody

<T> T getTypedMessageBody(java.lang.Class<T> clazz)

Returns a typed message, if applicable.

Type Parameters:

T - , the generic type

Parameters:

clazz, - the class to cast the message

Returns:

returns the typed message body

messageBodyEquals

boolean messageBodyEquals(java.lang.Object object)

Check if message equals given input.

Parameters:

object, - an object to check for equal

Returns:

returns true if object equals the message body