Class ContainerSharedObjectMessageSendingEvent
- java.lang.Object
-
- org.eclipse.ecf.core.sharedobject.events.ContainerSharedObjectMessageSendingEvent
-
- All Implemented Interfaces:
IContainerEvent,IContainerSharedObjectMessageSendingEvent,Event
public class ContainerSharedObjectMessageSendingEvent extends Object implements IContainerSharedObjectMessageSendingEvent
Event class implementingIContainerSharedObjectMessageSendingEvent.
-
-
Field Summary
Fields Modifier and Type Field Description protected IDlocalContainerIDprotected Objectmessageprotected IDsharedObjectIDprotected IDtargetContainerID
-
Constructor Summary
Constructors Constructor Description ContainerSharedObjectMessageSendingEvent(ID localContainerID, ID targetContainerID, ID sharedObjectID, Object message)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IDgetLocalContainerID()Get ID of local discovery container (the discovery container receiving this event).ObjectgetMessage()Get the message being sent.IDgetSharedObjectID()Get the shared object ID of the sending shared object.IDgetTargetContainerID()Get the target container ID for the message being sent.StringtoString()
-
-
-
Method Detail
-
getMessage
public Object getMessage()
Description copied from interface:IContainerSharedObjectMessageSendingEventGet the message being sent. This will return the message being sent by the shared object identified byIContainerSharedObjectMessageSendingEvent.getSharedObjectID(). May benullif null is being sent.- Specified by:
getMessagein interfaceIContainerSharedObjectMessageSendingEvent- Returns:
- Object the message being sent by the shared object identified via
IContainerSharedObjectMessageSendingEvent.getSharedObjectID(). May benull.
-
getSharedObjectID
public ID getSharedObjectID()
Description copied from interface:IContainerSharedObjectMessageSendingEventGet the shared object ID of the sending shared object. This value will not benulland the ID given will be the ID of a currently active shared object existing within the enclosing container.- Specified by:
getSharedObjectIDin interfaceIContainerSharedObjectMessageSendingEvent- Returns:
- ID of the shared object that is sending the message. Will not be
null.
-
getTargetContainerID
public ID getTargetContainerID()
Description copied from interface:IContainerSharedObjectMessageSendingEventGet the target container ID for the message being sent.- Specified by:
getTargetContainerIDin interfaceIContainerSharedObjectMessageSendingEvent- Returns:
- ID of target container for the message being sent. If
null, this indicates that all container members of group should receive the message being sent.
-
getLocalContainerID
public ID getLocalContainerID()
Description copied from interface:IContainerEventGet ID of local discovery container (the discovery container receiving this event).- Specified by:
getLocalContainerIDin interfaceIContainerEvent- Returns:
- ID for local container. Will not return
null.
-
-