com.revolsys.parallel.channel

Class ChannelValueStore<T>

java.lang.Object

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

Type Parameters:

T - The type of Object stored

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BlackHoleBuffer, Buffer, Overwrite, ZeroBuffer

public abstract class ChannelValueStore<T>
extends Object
implements Cloneable

Author:

Paul Austin

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EMPTY Specifies that the ChannelValueStore is empty and cannot give further data
protected static int	FULL Specifies that the ChannelValueStore is full and cannot accept further data
protected static int	NONEMPTYFULL Specifies that the ChannelValueStore is neither empty or full and can give and accept further data.

Constructor Summary

Constructors

Constructor and Description
ChannelValueStore()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

NONEMPTYFULL

protected static int NONEMPTYFULL

Specifies that the ChannelValueStore is neither empty or full and can give and accept further data.

EMPTY

protected static int EMPTY

Specifies that the ChannelValueStore is empty and cannot give further data

FULL

protected static int FULL

Specifies that the ChannelValueStore is full and cannot accept further data

Constructor Detail

ChannelValueStore

public ChannelValueStore()

Method Detail

clone

protected abstract 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.

Overrides:

clone in class Object

Returns:

The cloned instance of this Object.

get

protected abstract T get()

Returns the next available Object from the ChannelValueStore. NOTE: getState should be called before this method to check that the state is not EMPTY. If the state is EMPTY unpredictable results will occur. Pre-condition: The state must not be EMPTY

Returns:

The next available Object from the ChannelValueStore

getState

protected abstract int getState()

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

Returns:

The current state of the ChannelValueStore (EMPTY, NONEMPTYFULL or FULL)

put

protected abstract void put(T value)

Puts a new Object into the ChannelValueStore. NOTE: getState should be called before this method to check that the state is not FULL. If the state is FULL unpredictable results will occur. Pre-condition: The state must not be FULL

Parameters:

value - The object to put in the ChannelValueStore