org.jacpfx.rcp.message

Class MessageImpl

java.lang.Object

org.jacpfx.rcp.message.MessageImpl

All Implemented Interfaces:

java.lang.Cloneable, org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

public final class MessageImpl
extends java.lang.Object
implements org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

represents an message which is fired by an component, has a target and a message targeting the component itself or an other component

Author:

Andy Moncsek

Constructor Summary

Constructors

Constructor and Description
MessageImpl(java.lang.String sourceId)
MessageImpl(java.lang.String sourceId, javafx.event.Event event)
MessageImpl(java.lang.String sourceId, java.lang.Object message)
MessageImpl(java.lang.String sourceId, java.lang.String targetId, java.lang.Object message, javafx.event.Event event)

Method Summary

Modifier and Type	Method and Description
org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>	cloneMessage() Clone message and containing event.
java.lang.Object	getMessageBody() Get the message payload.
javafx.event.Event	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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageImpl

public MessageImpl(java.lang.String sourceId)

MessageImpl

public MessageImpl(java.lang.String sourceId,
                   javafx.event.Event event)

MessageImpl

public MessageImpl(java.lang.String sourceId,
                   java.lang.Object message)

MessageImpl

public MessageImpl(java.lang.String sourceId,
                   java.lang.String targetId,
                   java.lang.Object message,
                   javafx.event.Event event)

Method Detail

getMessageBody

public java.lang.Object getMessageBody()

Description copied from interface: org.jacpfx.api.message.Message

Get the message payload.

Specified by:

getMessageBody in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

M returns the message object

getSourceId

public java.lang.String getSourceId()

Description copied from interface: org.jacpfx.api.message.Message

Get the caller id.

Specified by:

getSourceId in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

the source id

getSourceEvent

public javafx.event.Event getSourceEvent()

Description copied from interface: org.jacpfx.api.message.Message

Get source of this message event.

Specified by:

getSourceEvent in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

the event

cloneMessage

public org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> cloneMessage()

Description copied from interface: org.jacpfx.api.message.Message

Clone message and containing event.

Specified by:

cloneMessage in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

a cloneMessage of current message instance

getTargetId

public java.lang.String getTargetId()

Description copied from interface: org.jacpfx.api.message.Message

Returns message target id.

Specified by:

getTargetId in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

the target id

isMessageBodyTypeOf

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

Description copied from interface: org.jacpfx.api.message.Message

Checks if message is type of a given class.

Specified by:

isMessageBodyTypeOf in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

true if message body type equals clazz

getTypedMessageBody

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

Description copied from interface: org.jacpfx.api.message.Message

Returns a typed message, if applicable.

Specified by:

getTypedMessageBody in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Type Parameters:

T - , the generic type

Returns:

returns the typed message body

messageBodyEquals

public boolean messageBodyEquals(java.lang.Object object)

Description copied from interface: org.jacpfx.api.message.Message

Check if message equals given input.

Specified by:

messageBodyEquals in interface org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>

Returns:

returns true if object equals the message body

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object