gr.uoa.di.madgik.grs.events

Class BufferEvent

java.lang.Object

gr.uoa.di.madgik.grs.events.BufferEvent

All Implemented Interfaces:

IPumpable, Serializable

Direct Known Subclasses:

KeyValueEvent, ObjectEvent

public abstract class BufferEvent
extends Object
implements IPumpable, Serializable

This is the base class that all events that can be emitted and received through the IBuffer must extend. All extenders of it must declare a default no arguments constructor

Author:

gpapanikos

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BufferEvent.EventSource The source of the event

Constructor Summary

Constructors

Constructor and Description
BufferEvent()

Method Summary

Methods

Modifier and Type	Method and Description
void	deflate(DataOutput out) Deflates the state and data of the implementor in a from capable of reconstructing the exact same instance
abstract void	extendDeflate(DataOutput out) This method is implemented by BufferEvent extenders to deflate the additional information they handle
abstract void	extendFromXML(Element element)
abstract void	extendInflate(DataInput in) This method is implemented by BufferEvent extenders to inflate the additional information they handle
abstract void	extendToXML(Document doc, Element element)
void	fromXML(Element element)
BufferEvent.EventSource	getSource() Retrieves the source of the event
void	inflate(DataInput in) Inflate the state and data of the implementor as was previously deflated using IPumpable.deflate(DataOutput)
void	inflate(DataInput in, boolean reset) Inflate the state and data of the implementor as was previously deflated using IPumpable.deflate(DataOutput)
void	setSource(BufferEvent.EventSource source) Sets the event source
Element	toXML(Document doc)

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferEvent

public BufferEvent()

Method Detail

getSource

public BufferEvent.EventSource getSource()

Retrieves the source of the event

Returns:

the event source

setSource

public void setSource(BufferEvent.EventSource source)

Sets the event source

Parameters:

source - the event source

deflate

public void deflate(DataOutput out)
             throws GRS2RecordSerializationException

Deflates the state and data of the implementor in a from capable of reconstructing the exact same instance

Specified by:

deflate in interface IPumpable

Parameters:

out - the stream to write to

Throws:

GRS2RecordSerializationException - the deflate could not be completed

See Also:

IPumpable.deflate(java.io.DataOutput)

extendDeflate

public abstract void extendDeflate(DataOutput out)
                            throws GRS2RecordSerializationException

This method is implemented by BufferEvent extenders to deflate the additional information they handle

Parameters:

out - the stream to deflate to

Throws:

GRS2RecordSerializationException - there was a problem deflating the event

inflate

public void inflate(DataInput in)
             throws GRS2RecordSerializationException

Inflate the state and data of the implementor as was previously deflated using IPumpable.deflate(DataOutput)

Specified by:

inflate in interface IPumpable

Parameters:

in - the stream to inflate from

Throws:

GRS2RecordSerializationException - the inflate could not be completed

See Also:

IPumpable.inflate(java.io.DataInput)

inflate

public void inflate(DataInput in,
           boolean reset)
             throws GRS2RecordSerializationException

Inflate the state and data of the implementor as was previously deflated using IPumpable.deflate(DataOutput)

Specified by:

inflate in interface IPumpable

Parameters:

in - the stream to inflate from

reset - if the implementor keeps some state over actions previously taken and this is true, this state must be reset

Throws:

GRS2RecordSerializationException - the inflate could not be completed

See Also:

IPumpable.inflate(java.io.DataInput, boolean)

extendInflate

public abstract void extendInflate(DataInput in)
                            throws GRS2RecordSerializationException

This method is implemented by BufferEvent extenders to inflate the additional information they handle

Parameters:

in - the stream to inflate from

Throws:

GRS2RecordSerializationException - there was a problem inflating the event

toXML

public Element toXML(Document doc)
              throws GRS2RecordSerializationException,
                     GRS2RecordDefinitionException,
                     DOMException

Specified by:

toXML in interface IPumpable

Throws:

GRS2RecordSerializationException

GRS2RecordDefinitionException

DOMException

fromXML

public void fromXML(Element element)
             throws GRS2RecordSerializationException,
                    GRS2RecordDefinitionException,
                    DOMException

Specified by:

fromXML in interface IPumpable

Throws:

GRS2RecordSerializationException

GRS2RecordDefinitionException

DOMException

extendToXML

public abstract void extendToXML(Document doc,
               Element element)
                          throws GRS2RecordSerializationException

Throws:

GRS2RecordSerializationException

extendFromXML

public abstract void extendFromXML(Element element)
                            throws GRS2RecordSerializationException

Throws:

GRS2RecordSerializationException