All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jcsp.util.Buffer 

java.lang.Object
   |
   +----jcsp.lang.ChannelDataStore
           |
           +----jcsp.util.Buffer
public class Buffer
extends ChannelDataStore

Description

The Buffer class is an implementation of ChannelDataStore which allows more than one Object to be sent across the Channel at any one time. The Buffer will store the Objects and allow them to be read in the same order as they were written. A Buffer of size 0 acts the same as the ZeroBuffer ChannelDataStore.

The getState method will return EMPTY if the Channel does not contain any Objects, FULL if it cannot accept more data and NONEMPTYFULL otherwise.

Author:
P.D.Austin

Constructor Index

o Buffer(int)
Construct a new Buffer with the specified size.

Method Index

o clone()
Returns a new Object with the same creation parameters as this Object.
o get()
Returns the first Object from the Buffer and removes the Object from the Buffer.
o getState()
Returns the current state of the Buffer, should be called to ensure the Pre-conditions of the other methods are not broken.
o put(Object)
Puts a new Object into the Buffer.

Constructors

o Buffer 
 public Buffer(int size)
Construct a new Buffer with the specified size.

Parameters:
size - The number of Objects the Buffer can store

Methods

o get 
 protected Object get()
Returns the first Object from the Buffer and removes the Object from the Buffer.

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

Pre-condition: The state must not be EMPTY

Returns:
The next available Object from the Buffer
Overrides:
get in class ChannelDataStore
o put 
 protected void put(Object value)
Puts a new Object into the Buffer.

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

Pre-condition: The state must not be FULL

Parameters:
value - The object to put in the Buffer
Overrides:
put in class ChannelDataStore
o getState 
 protected int getState()
Returns the current state of the Buffer, should be called to ensure the Pre-conditions of the other methods are not broken.

Returns:
The current state of the Buffer (EMPTY, NONEMPTYFULL or FULL)
Overrides:
getState in class ChannelDataStore
o 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.

Returns:
The cloned instance of this Object.
Overrides:
clone in class ChannelDataStore 
All Packages  Class Hierarchy  This Package  Previous  Next  Index