public class OverFlowingBufferInt extends java.lang.Object implements ChannelDataStoreInt, java.io.Serializable
Channel
(Channel.one2oneInt(org.jcsp.util.ints.ChannelDataStoreInt)
etc.).
The getState method returns EMPTY or NONEMPTYFULL, but never FULL.
Modifier and Type | Field and Description |
---|---|
private int[] |
buffer
The storage for the buffered ints
|
private int |
counter
The number of ints stored in the Buffer
|
private int |
firstIndex
The index of the oldest element (when counter > 0)
|
private int |
lastIndex
The index of the next free element (when counter < buffer.length)
|
EMPTY, FULL, NONEMPTYFULL
Constructor and Description |
---|
OverFlowingBufferInt(int size)
Construct a new OverFlowingBufferInt with the specified size.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Returns a new (and EMPTY) OverFlowingBufferInt with the same
creation parameters as this one.
|
void |
endGet()
Removes the oldest integer from the buffer.
|
int |
get()
Returns the oldest int from the OverFlowingBufferInt and removes it.
|
int |
getState()
Returns the current state of the OverFlowingBufferInt.
|
void |
put(int value)
Puts a new int into the OverFlowingBufferInt.
|
void |
removeAll() |
int |
startGet()
Returns the oldest integer from the buffer but does not remove it.
|
private final int[] buffer
private int counter
private int firstIndex
private int lastIndex
public OverFlowingBufferInt(int size)
size
- the number of ints the OverFlowingBufferInt can store.BufferIntSizeError
- 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 int get()
Pre-condition: getState must not currently return EMPTY.
get
in interface ChannelDataStoreInt
public int startGet()
startGet
in interface ChannelDataStoreInt
ChannelDataStoreInt.endGet()
public void endGet()
endGet
in interface ChannelDataStoreInt
ChannelDataStoreInt.startGet()
public void put(int value)
If OverFlowingBufferInt is full, the item is discarded.
put
in interface ChannelDataStoreInt
value
- the int to put into the OverFlowingBufferIntpublic int getState()
getState
in interface ChannelDataStoreInt
public java.lang.Object clone()
Note: Only the size and structure of the OverFlowingBufferInt is cloned, not any stored data.
clone
in interface ChannelDataStoreInt
clone
in class java.lang.Object
public void removeAll()
removeAll
in interface ChannelDataStoreInt