gr.uoa.di.madgik.grs.events

Class KeyValueEvent

java.lang.Object

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

gr.uoa.di.madgik.grs.events.KeyValueEvent

All Implemented Interfaces:

IPumpable, Serializable

public class KeyValueEvent
extends BufferEvent

BufferEvent extender that propagates a simple string based key value pair as the event payload

Author:

gpapanikos

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gr.uoa.di.madgik.grs.events.BufferEvent

BufferEvent.EventSource

Constructor Summary

Constructors

Constructor and Description
KeyValueEvent() Create a new instance
KeyValueEvent(String key, String value) Create a new instance

Method Summary

Methods

Modifier and Type	Method and Description
void	extendDeflate(DataOutput out) This method is implemented by BufferEvent extenders to deflate the additional information they handle
void	extendFromXML(Element element)
void	extendInflate(DataInput in) This method is implemented by BufferEvent extenders to inflate the additional information they handle
void	extendToXML(Document doc, Element element)
String	getKey() Retrieves the payload key
String	getValue() Retrieves the payload value
void	setKey(String key) Sets the payload key
void	setValue(String value) Sets the payload value

Methods inherited from class gr.uoa.di.madgik.grs.events.BufferEvent

deflate, fromXML, getSource, inflate, inflate, setSource, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueEvent

public KeyValueEvent()

Create a new instance

KeyValueEvent

public KeyValueEvent(String key,
             String value)

Create a new instance

Parameters:

key - the key of the payload

value - the value of the payload

Method Detail

getKey

public String getKey()

Retrieves the payload key

Returns:

the payload key

setKey

public void setKey(String key)

Sets the payload key

Parameters:

key - the payload key

getValue

public String getValue()

Retrieves the payload value

Returns:

the payload value

setValue

public void setValue(String value)

Sets the payload value

Parameters:

value - the payload value

extendToXML

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

Specified by:

extendToXML in class BufferEvent

Throws:

GRS2RecordSerializationException

extendFromXML

public void extendFromXML(Element element)
                   throws GRS2RecordSerializationException

Specified by:

extendFromXML in class BufferEvent

Throws:

GRS2RecordSerializationException

extendDeflate

public void extendDeflate(DataOutput out)
                   throws GRS2RecordSerializationException

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

Specified by:

extendDeflate in class BufferEvent

Parameters:

out - the stream to deflate to

Throws:

GRS2RecordSerializationException - there was a problem deflating the event

See Also:

BufferEvent.extendDeflate(java.io.DataOutput)

extendInflate

public void extendInflate(DataInput in)
                   throws GRS2RecordSerializationException

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

Specified by:

extendInflate in class BufferEvent

Parameters:

in - the stream to inflate from

Throws:

GRS2RecordSerializationException - there was a problem inflating the event

See Also:

BufferEvent.extendInflate(java.io.DataInput)