org.openbandy.net.client
Class IncomingMessageEvent

java.lang.Object
  org.openbandy.event.Event
      org.openbandy.net.client.IncomingMessageEvent

public class IncomingMessageEvent
extends Event

This Event reports the reception of a Message at the MessageScanner. Interested EventSinks may choose to fetch the message by reading either the class name of the message contained serializable or by reading the type of the message. As this type of Event is only used in-node (i.e. it will no be exchanged between nodes), it does not have to be stream serializable.

Version:

1.0

Author:

Philipp Bolliger (philipp@bolliger.name)

Field Summary

Fields inherited from class org.openbandy.event.Event

DEFAULT_VALIDITY

Constructor Summary

IncomingMessageEvent()

Method Summary

void	deserialize(Serializer serializer, SerializationBuffer buffer)
void	deserializeSuper(Serializer serializer, SerializationBuffer buffer)
void	getAttributeNames(java.util.Vector attributes)
java.lang.String	getContentClassName() TODO comment!
Serializable	getCopy()
java.lang.String	getIdName()
int	getIdValue()
java.lang.String	getLegibleString()
int	getMessageQueueId() TODO comment!
int	getMessageType() TODO comment!
void	getReferenceNames(java.util.Vector referenceNames)
void	getReferences(java.util.Vector references)
Serializable	getSuperCopy()
boolean	isEqual(Serializable serializableObject)
boolean	isEqualShallow(Serializable serializableObject)
void	serialize(Serializer serializer, SerializationBuffer buffer)
void	setContentClassName(java.lang.String contentClassName) TODO comment!
void	setIdValue(int idValue)
void	setMessageQueueId(int messageQueueId) TODO comment!
void	setMessageType(int messageType) TODO comment!
void	setValidity(int validity) Set the validity of the Event in minutes

Methods inherited from class org.openbandy.event.Event

getCreationTime, getValidity

Methods inherited from class java.lang.Object

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

Constructor Detail

IncomingMessageEvent

public IncomingMessageEvent()

Method Detail

getContentClassName

public java.lang.String getContentClassName()

TODO comment!

Returns:

setContentClassName

public void setContentClassName(java.lang.String contentClassName)

TODO comment!

Parameters:

contentClassName -

getMessageQueueId

public int getMessageQueueId()

TODO comment!

Returns:

setMessageQueueId

public void setMessageQueueId(int messageQueueId)

TODO comment!

Parameters:

messageQueueId -

getMessageType

public int getMessageType()

TODO comment!

Returns:

setMessageType

public void setMessageType(int messageType)

TODO comment!

Parameters:

messageType -

deserialize

public void deserialize(Serializer serializer,
                        SerializationBuffer buffer)

deserializeSuper

public void deserializeSuper(Serializer serializer,
                             SerializationBuffer buffer)

getAttributeNames

public void getAttributeNames(java.util.Vector attributes)

getCopy

public Serializable getCopy()

getIdName

public java.lang.String getIdName()

getIdValue

public int getIdValue()

getLegibleString

public java.lang.String getLegibleString()

getReferenceNames

public void getReferenceNames(java.util.Vector referenceNames)

getReferences

public void getReferences(java.util.Vector references)

getSuperCopy

public Serializable getSuperCopy()

isEqual

public boolean isEqual(Serializable serializableObject)
                throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

isEqualShallow

public boolean isEqualShallow(Serializable serializableObject)
                       throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

serialize

public void serialize(Serializer serializer,
                      SerializationBuffer buffer)

setIdValue

public void setIdValue(int idValue)

setValidity

public void setValidity(int validity)

Description copied from class: Event

Set the validity of the Event in minutes

Overrides:

setValidity in class Event

Parameters:

validity - Event validity in minutes