public class OverWritingBuffer<T> extends java.lang.Object implements ChannelDataStore<T>, java.io.Serializable
Channel
(Channel.one2one(org.jcsp.util.ChannelDataStore)
etc.).
The getState method returns EMPTY or NONEMPTYFULL, but never FULL.
ZeroBuffer
,
Buffer
,
OverWriteOldestBuffer
,
OverFlowingBuffer
,
InfiniteBuffer
,
Channel
,
Serialized FormEMPTY, FULL, NONEMPTYFULL
Constructor and Description |
---|
OverWritingBuffer(int size)
Construct a new OverWritingBuffer with the specified size.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Returns a new (and EMPTY) OverWritingBuffer with the same
creation parameters as this one.
|
void |
endGet()
This ends an extended rendezvous by the reader.
|
T |
get()
Returns the oldest Object from the OverWritingBuffer and removes it.
|
int |
getState()
Returns the current state of the OverWritingBuffer.
|
void |
put(T value)
Puts a new Object into the OverWritingBuffer.
|
void |
removeAll()
Deletes all items in the buffer, leaving it empty.
|
T |
startGet()
This begins an extended rendezvous by the reader.
|
public OverWritingBuffer(int size)
size
- the number of Objects the OverWritingBuffer 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 T get()
Pre-condition: getState must not currently return EMPTY.
get
in interface ChannelDataStore<T>
public void put(T value)
If OverWritingBuffer is full, the last item previously put into the buffer will be overwritten.
put
in interface ChannelDataStore<T>
value
- the Object to put into the OverWritingBufferpublic T startGet()
If the buffer is of size 2 or larger, the semantics are as follows. Beginning an extended rendezvous will return the oldest value in the buffer, but not remove it. If the writer writes to the buffer during the rendezvous, it will grow the buffer and end up overwriting the newest value as normal. At the end of the extended rendezvous, the oldest value is removed.
If the buffer is of size 1, the semantics are identical to those of an OverWriteOldestBuffer
.
For a complete description, refer to the documentation for the OverWriteOldestBuffer.startGet()
method.
startGet
in interface ChannelDataStore<T>
ChannelDataStore.endGet()
public void endGet()
endGet
in interface ChannelDataStore<T>
startGet()
public int getState()
getState
in interface ChannelDataStore<T>
public java.lang.Object clone()
Note: Only the size and structure of the OverWritingBuffer is cloned, not any stored data.
clone
in interface ChannelDataStore<T>
clone
in class java.lang.Object
public void removeAll()
ChannelDataStore
removeAll
in interface ChannelDataStore<T>
Copyright © 1996–2018. All rights reserved.