Class OverFlowingBufferInt

    • Constructor Detail

      • OverFlowingBufferInt

        public OverFlowingBufferInt​(int size)
        Construct a new OverFlowingBufferInt with the specified size.
        Parameters:
        size - the number of ints the OverFlowingBufferInt can store.
        Throws:
        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.
    • Method Detail

      • get

        public int get()
        Returns the oldest int from the OverFlowingBufferInt and removes it.

        Pre-condition: getState must not currently return EMPTY.

        Specified by:
        get in interface ChannelDataStoreInt
        Returns:
        the oldest int from the OverFlowingBufferInt
      • 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 interface ChannelDataStoreInt
        Returns:
        the oldest int from the Buffer
        See Also:
        ChannelDataStoreInt.endGet()
      • put

        public void put​(int value)
        Puts a new int into the OverFlowingBufferInt.

        If OverFlowingBufferInt is full, the item is discarded.

        Specified by:
        put in interface ChannelDataStoreInt
        Parameters:
        value - the int to put into the OverFlowingBufferInt
      • getState

        public int getState()
        Returns the current state of the OverFlowingBufferInt.
        Specified by:
        getState in interface ChannelDataStoreInt
        Returns:
        the current state of the OverFlowingBufferInt (EMPTY or NONEMPTYFULL)
      • clone

        public Object clone()
        Returns a new (and EMPTY) OverFlowingBufferInt with the same creation parameters as this one.

        Note: Only the size and structure of the OverFlowingBufferInt is cloned, not any stored data.

        Specified by:
        clone in interface ChannelDataStoreInt
        Overrides:
        clone in class Object
        Returns:
        the cloned instance of this OverFlowingBufferInt.