|
CSP for Java (JCSP) 1.1-rc4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jcsp.util.OverWritingBuffer
public class OverWritingBuffer
This is used to create a buffered object channel that always accepts input, overwriting its last entered data if full.
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 FormField Summary |
---|
Fields inherited from interface org.jcsp.util.ChannelDataStore |
---|
EMPTY, FULL, NONEMPTYFULL |
Constructor Summary | |
---|---|
OverWritingBuffer(int size)
Construct a new OverWritingBuffer with the specified size. |
Method Summary | |
---|---|
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. |
Object |
get()
Returns the oldest Object from the OverWritingBuffer and removes it. |
int |
getState()
Returns the current state of the OverWritingBuffer. |
void |
put(Object value)
Puts a new Object into the OverWritingBuffer. |
void |
removeAll()
Deletes all items in the buffer, leaving it empty. |
Object |
startGet()
This begins an extended rendezvous by the reader. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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.Method Detail |
---|
public Object get()
Pre-condition: getState must not currently return EMPTY.
get
in interface ChannelDataStore
public void put(Object value)
If OverWritingBuffer is full, the last item previously put into the buffer will be overwritten.
put
in interface ChannelDataStore
value
- the Object to put into the OverWritingBufferpublic Object 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
ChannelDataStore.endGet()
public void endGet()
endGet
in interface ChannelDataStore
startGet()
public int getState()
getState
in interface ChannelDataStore
public Object clone()
Note: Only the size and structure of the OverWritingBuffer is cloned, not any stored data.
clone
in interface ChannelDataStore
clone
in class Object
public void removeAll()
ChannelDataStore
removeAll
in interface ChannelDataStore
|
CSP for Java (JCSP) 1.1-rc4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |