Package org.jcsp.util.ints
Class BufferInt
java.lang.Object
org.jcsp.util.ints.BufferInt
- All Implemented Interfaces:
Serializable
,Cloneable
,ChannelDataStoreInt
This is used to create a buffered integer channel that never loses data.
Description
BufferInt is an implementation of ChannelDataStoreInt that yields a blocking FIFO buffered semantics for a channel. See the static construction methods ofChannel
(Channel.one2oneInt(org.jcsp.util.ints.ChannelDataStoreInt)
etc.).
The getState method returns EMPTY, NONEMPTYFULL or FULL according to the state of the buffer.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int[]
The storage for the buffered intsprivate int
The number of ints stored in the BufferIntprivate int
The index of the oldest element (when counter > 0)private int
The index of the next free element (when counter invalid input: '<' buffer.length)Fields inherited from interface org.jcsp.util.ints.ChannelDataStoreInt
EMPTY, FULL, NONEMPTYFULL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a new (and EMPTY) BufferInt 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 BufferInt and removes it.int
getState()
Returns the current state of the BufferInt.void
put
(int value) Puts a new int into the BufferInt.void
int
startGet()
Returns the oldest integer from the buffer but does not remove it.
-
Field Details
-
buffer
private final int[] bufferThe storage for the buffered ints -
counter
private int counterThe number of ints stored in the BufferInt -
firstIndex
private int firstIndexThe index of the oldest element (when counter > 0) -
lastIndex
private int lastIndexThe index of the next free element (when counter invalid input: '<' buffer.length)
-
-
Constructor Details
-
BufferInt
public BufferInt(int size) Construct a new BufferInt with the specified size.- Parameters:
size
- the number of ints the BufferInt can store.- Throws:
BufferIntSizeError
- 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 Details
-
get
public int get()Returns the oldest int from the BufferInt and removes it.Pre-condition: getState must not currently return EMPTY.
- Specified by:
get
in interfaceChannelDataStoreInt
- Returns:
- the oldest int from the BufferInt
-
startGet
public int startGet()Returns the oldest integer from the buffer but does not remove it. Pre-condition: getState must not currently return EMPTY.- Specified by:
startGet
in interfaceChannelDataStoreInt
- Returns:
- the oldest int from the Buffer
- See Also:
-
endGet
public void endGet()Removes the oldest integer from the buffer.- Specified by:
endGet
in interfaceChannelDataStoreInt
- See Also:
-
put
public void put(int value) Puts a new int into the BufferInt.Pre-condition: getState must not currently return FULL.
- Specified by:
put
in interfaceChannelDataStoreInt
- Parameters:
value
- the int to put into the BufferInt
-
getState
public int getState()Returns the current state of the BufferInt.- Specified by:
getState
in interfaceChannelDataStoreInt
- Returns:
- the current state of the BufferInt (EMPTY, NONEMPTYFULL or FULL)
-
clone
Returns a new (and EMPTY) BufferInt with the same creation parameters as this one.Note: Only the size and structure of the BufferInt is cloned, not any stored data.
- Specified by:
clone
in interfaceChannelDataStoreInt
- Overrides:
clone
in classObject
- Returns:
- the cloned instance of this BufferInt
-
removeAll
public void removeAll()- Specified by:
removeAll
in interfaceChannelDataStoreInt
-