|
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.Buffer
public class Buffer
This is used to create a buffered object channel that never loses data.
Channel
(Channel.one2one(org.jcsp.util.ChannelDataStore)
etc.).
The getState method returns EMPTY, NONEMPTYFULL or FULL according to the state of the buffer.
ZeroBuffer
,
OverWriteOldestBuffer
,
OverWritingBuffer
,
OverFlowingBuffer
,
InfiniteBuffer
,
Channel
,
Serialized FormField Summary |
---|
Fields inherited from interface org.jcsp.util.ChannelDataStore |
---|
EMPTY, FULL, NONEMPTYFULL |
Constructor Summary | |
---|---|
Buffer(int size)
Construct a new Buffer with the specified size. |
Method Summary | |
---|---|
Object |
clone()
Returns a new (and EMPTY) Buffer 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 Buffer and removes it. |
int |
getState()
Returns the current state of the Buffer. |
void |
put(Object value)
Puts a new Object into the Buffer. |
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. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Buffer(int size)
size
- the number of Objects the Buffer can store.
BufferSizeError
- if size is 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 Object startGet()
startGet
in interface ChannelDataStore
ChannelDataStore.endGet()
public void endGet()
endGet
in interface ChannelDataStore
ChannelDataStore.startGet()
public void put(Object value)
Pre-condition: getState must not currently return FULL.
put
in interface ChannelDataStore
value
- the Object to put into the Bufferpublic int getState()
getState
in interface ChannelDataStore
public Object clone()
Note: Only the size and structure of the Buffer 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 |