net.kwfgrid.gwes.uiproxy
Interface Buffer

All Superinterfaces:

Consumer

All Known Implementing Classes:

AbstractBuffer, DefaultBuffer, JDOMSequenceBuffer, SequenceBuffer

public interface Buffer
extends Consumer

Interface for all buffers in the proxy.

Method Summary

String	getID() Get the buffers unique ID.
void	handle(Object message) Handle a message.
Object[]	read() Read buffered messages.
void	setProperties(Properties props) Set the buffers properties.
void	setProperty(String name, String value) Set a property of the buffer.

Method Detail

getID

String getID()

Get the buffers unique ID.

setProperties

void setProperties(Properties props)
                   throws BufferException

Set the buffers properties.

Throws:

BufferException

setProperty

void setProperty(String name,
                 String value)
                 throws BufferException

Set a property of the buffer.

Throws:

BufferException

handle

void handle(Object message)

Handle a message. The buffer itself determines if it is responsible for buffering the specified Message. Buffer overflows or other exceptions must be remembered internally and notified on forthcoming calls of read().

Specified by:

handle in interface Consumer

Parameters:

message - The message.

read

Object[] read()
              throws BufferException

Read buffered messages. Details are determined by the implementations.

Throws:

BufferException - If a message could not be handled for some reason.