com.revolsys.parallel.channel.store

Class BlackHoleBuffer<T>

java.lang.Object

com.revolsys.parallel.channel.ChannelValueStore<T>

com.revolsys.parallel.channel.store.BlackHoleBuffer<T>

All Implemented Interfaces:

Cloneable

public class BlackHoleBuffer<T>
extends ChannelValueStore<T>

Description

The ZeroBuffer class is an implementation of ChannelValueStore which allows one Object to be sent across the Channel at any one time.

The getState method will return EMPTY if the Channel does not contain an Object and FULL if it does.

Author:

P.D.Austin

Field Summary

Fields inherited from class com.revolsys.parallel.channel.ChannelValueStore

EMPTY, FULL, NONEMPTYFULL

Constructor Summary

Constructors

Constructor and Description
BlackHoleBuffer()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	clone() Returns a new Object with the same creation parameters as this Object.
protected T	get() Returns the Object from the ZeroBuffer.
protected int	getState() Returns the current state of the ZeroBuffer, should be called to ensure the Pre-conditions of the other methods are not broken.
protected void	put(T value) Puts a new Object into the ZeroBuffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlackHoleBuffer

public BlackHoleBuffer()

Method Detail

clone

protected Object clone()

Returns a new Object with the same creation parameters as this Object. This method should be overridden by subclasses to return a new Object that is the same type as this Object. The new instance should be created by constructing a new instance with the same parameters as the original. NOTE: Only the sizes of the data should be cloned not the stored data.

Specified by:

clone in class ChannelValueStore<T>

Returns:

The cloned instance of this Object.

get

protected T get()

Returns the Object from the ZeroBuffer.

NOTE: getState should be called before this method to check that the state is not EMPTY. If the state is EMPTY the ZeroBuffer will be left in an undefined state.

Pre-condition: The state must not be EMPTY

Specified by:

get in class ChannelValueStore<T>

Returns:

The next available Object from the ChannelValueStore

getState

protected int getState()

Returns the current state of the ZeroBuffer, should be called to ensure the Pre-conditions of the other methods are not broken.

Specified by:

getState in class ChannelValueStore<T>

Returns:

The current state of the ZeroBuffer (EMPTY or FULL)

put

protected void put(T value)

Puts a new Object into the ZeroBuffer.

NOTE: getState should be called before this method to check that the state is not FULL. If the state is FULL the ZeroBuffer will be left in an undefined state.

Pre-condition: The state must not be FULL

Specified by:

put in class ChannelValueStore<T>

Parameters:

value - The object to put in the ChannelValueStore