gr.uoa.di.madgik.commons.channel.events

Class ObjectPayloadChannelEvent

java.lang.Object

java.util.Observable

gr.uoa.di.madgik.commons.channel.events.ChannelStateEvent

gr.uoa.di.madgik.commons.channel.events.ChannelPayloadStateEvent

gr.uoa.di.madgik.commons.channel.events.ObjectPayloadChannelEvent

All Implemented Interfaces:

ISerializable, Serializable

public class ObjectPayloadChannelEvent
extends ChannelPayloadStateEvent

Event containing payload that the sender wants to provide to listeners

Author:

gpapanikos

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectPayloadChannelEvent() Instantiates a new object payload channel event.
ObjectPayloadChannelEvent(ISerializable Value) Instantiates a new object payload channel event.

Method Summary

Modifier and Type	Method and Description
void	Decode(byte[] payload) Decodes the payload of the implementing object as it was returned by ISerializable.Encode()
byte[]	Encode() Encodes the payload of the implementing object so that is can later be unmarshaled
ChannelState.EventName	GetEventName() Gets the event name.
String	GetSerializableClassName() Gets the class name of the object being serialized.
ISerializable	GetValue() Retrieves the containing payload
void	SetValue(ISerializable Value) Sets the containing payload

Methods inherited from class gr.uoa.di.madgik.commons.channel.events.ChannelStateEvent

DeserializeID, GetEmitingNozzleID, GetEmitingNozzleIdentifierLeastSignificantBits, GetEmitingNozzleIdentifierMostSignificantBits, NotifyChange, SerializeEmmitingNozzleID, SetEmitingNozzleIdentifierLeastSignificantBits, SetEmitingNozzleIdentifierMostSignificantBits

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPayloadChannelEvent

public ObjectPayloadChannelEvent()

Instantiates a new object payload channel event.

ObjectPayloadChannelEvent

public ObjectPayloadChannelEvent(ISerializable Value)

Instantiates a new object payload channel event.

Parameters:

Value - the payload that the event contains

Method Detail

GetEventName

public ChannelState.EventName GetEventName()

Description copied from class: ChannelStateEvent

Gets the event name.

Specified by:

GetEventName in class ChannelStateEvent

Returns:

the channel state. event name

GetValue

public ISerializable GetValue()

Retrieves the containing payload

Returns:

the contained payload

SetValue

public void SetValue(ISerializable Value)

Sets the containing payload

Parameters:

Value - the containing payload

GetSerializableClassName

public String GetSerializableClassName()

Description copied from interface: ISerializable

Gets the class name of the object being serialized. This name is used to instantiate the object when unmarshaled

Returns:

the class name

Decode

public void Decode(byte[] payload)
            throws Exception

Description copied from interface: ISerializable

Decodes the payload of the implementing object as it was returned by ISerializable.Encode()

Parameters:

payload - the serialization

Throws:

Exception - the Serialization could not be performed

Encode

public byte[] Encode()
              throws Exception

Description copied from interface: ISerializable

Encodes the payload of the implementing object so that is can later be unmarshaled

Returns:

the byte[] the encoded payload

Throws:

Exception - The serialization could not be performed