org.jcsp.util
public class OverFlowingBuffer extends Object implements ChannelDataStore, Serializable
Channel
(Channel.one2one(org.jcsp.util.ChannelDataStore)
etc.).
The getState method returns EMPTY or NONEMPTYFULL, but never FULL.
ZeroBuffer
,
Buffer
,
OverWriteOldestBuffer
,
OverWritingBuffer
,
InfiniteBuffer
,
Channel
,
Serialized FormEMPTY, FULL, NONEMPTYFULL
Constructor and Description |
---|
OverFlowingBuffer(int size)
Construct a new OverFlowingBuffer with the specified size.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Returns a new (and EMPTY) OverFlowingBuffer with the same
creation parameters as this one.
|
void |
endGet()
Removes the oldest object from the buffer.
|
Object |
get()
Returns the oldest Object from the OverFlowingBuffer and removes it.
|
int |
getState()
Returns the current state of the OverFlowingBuffer.
|
void |
put(Object value)
Puts a new Object into the OverFlowingBuffer.
|
void |
removeAll()
Deletes all items in the buffer, leaving it empty.
|
Object |
startGet()
Returns the oldest object from the buffer but does not remove it.
|
public OverFlowingBuffer(int size)
size
- the number of Objects the OverFlowingBuffer can store.BufferSizeError
- if size is zero or negative. Note: no action
should be taken to try/catch this exception
- application code generating it is in error and needs correcting.public Object get()
Pre-condition: getState must not currently return EMPTY.
get
in interface ChannelDataStore
public Object startGet()
startGet
in interface ChannelDataStore
ChannelDataStore.endGet()
public void endGet()
endGet
in interface ChannelDataStore
ChannelDataStore.startGet()
public void put(Object value)
If OverFlowingBuffer is full, the item is discarded.
put
in interface ChannelDataStore
value
- the Object to put into the OverFlowingBufferpublic int getState()
getState
in interface ChannelDataStore
public Object clone()
Note: Only the size and structure of the OverFlowingBuffer is cloned, not any stored data.
clone
in interface ChannelDataStore
clone
in class Object
public void removeAll()
ChannelDataStore
removeAll
in interface ChannelDataStore
Submit a bug or feature to jcsp-team@kent.ac.uk
Version 1.1-rc4 of the JCSP API Specification (Copyright 1997-2008 P.D.Austin and P.H.Welch - All Rights Reserved)
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.