eve.util

Class ObjectBuffer

java.lang.Object

eve.util.ObjectBuffer

public class ObjectBuffer
extends Object

This is used to pass Object data from one Thread to another safely without leaving unhandled data.

Field Summary

Fields

Modifier and Type	Field and Description
int	maxSize

Constructor Summary

Constructors

Constructor and Description
ObjectBuffer() Create an ObjectBuffer with no maximum size.
ObjectBuffer(int maxSize) Create an ObjectBuffer with a maximum size.

Method Summary

Modifier and Type	Method and Description
void	close() This closes the buffer so no more data can be put in it - however data can still be taken out of it.
protected void	closed() This is called when the buffer is closed.
Object	get(TimeOut howLong) Get an Object from the buffer.
Object	get(TimeOut howLong, boolean closeIfFailed) Get an Object from the buffer.
boolean	isClosed() Returns if the buffer is closed so no more data can be put into it.
boolean	put(Object data) Place data in the buffer but do not wait if the buffer is full.
boolean	put(Object data, TimeOut howLong) Place data in the buffer waiting if the buffer is full.

Methods inherited from class java.lang.Object

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

Field Detail

maxSize

public int maxSize

Constructor Detail

ObjectBuffer

public ObjectBuffer(int maxSize)

Create an ObjectBuffer with a maximum size. If this size is negative then there is no maximum size.

Parameters:

maxSize - the maximum number of Objects the buffer can hold.

ObjectBuffer

public ObjectBuffer()

Create an ObjectBuffer with no maximum size.

Method Detail

isClosed

public boolean isClosed()

Returns if the buffer is closed so no more data can be put into it. If it is closed but data remains in it that data can still be taken out.

close

public void close()

This closes the buffer so no more data can be put in it - however data can still be taken out of it.

closed

protected void closed()

This is called when the buffer is closed. It is synchronized with this Object.

get

public Object get(TimeOut howLong)
           throws InterruptedException

Get an Object from the buffer.

Parameters:

howLong - the length of time to wait for the next object.

Returns:

the Object or null if there was no Object ready or if the TimeOut expired. Use isClosed() to determine if the buffer is closed.

Throws:

InterruptedException - if the Thread was interrupted.

get

public Object get(TimeOut howLong,
                  boolean closeIfFailed)
           throws InterruptedException

Get an Object from the buffer.

Parameters:

howLong - the length of time to wait for the next object.

closeIfFailed - set this true if you want to close the buffer if data does not arrive in time or if ther Thread is interrupted.

Returns:

the Object or null if there was no Object ready or if the TimeOut expired. Use isClosed() to determine if the buffer is closed.

Throws:

InterruptedException - if the Thread was interrupted.

put

public boolean put(Object data,
                   TimeOut howLong)
            throws InterruptedException

Place data in the buffer waiting if the buffer is full.

Parameters:

data - the data to put in the buffer.

howLong - how long to wait.

Returns:

true if the data was placed in the buffer, false if not because the buffer is full or the buffer is closed. Use isClosed() to determine if the buffer is closed.

Throws:

InterruptedException

put

public boolean put(Object data)

Place data in the buffer but do not wait if the buffer is full.

Parameters:

data - the data to put in the buffer.

Returns:

true if the data was placed in the buffer, false if not because the buffer is full or the buffer is closed. Use isClosed() to determine if the buffer is closed.