Class BufferInt

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int[] buffer
      The storage for the buffered ints
      private int counter
      The number of ints stored in the BufferInt
      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)
    • Constructor Summary

      Constructors 
      Constructor Description
      BufferInt​(int size)
      Construct a new BufferInt with the specified size.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      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 removeAll()  
      int startGet()
      Returns the oldest integer 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
    • Field Detail

      • buffer

        private final int[] buffer
        The storage for the buffered ints
      • counter

        private int counter
        The number of ints stored in the BufferInt
      • firstIndex

        private int firstIndex
        The index of the oldest element (when counter > 0)
      • lastIndex

        private int lastIndex
        The index of the next free element (when counter < buffer.length)
    • Constructor Detail

      • 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 Detail

      • 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 interface ChannelDataStoreInt
        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 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 BufferInt.

        Pre-condition: getState must not currently return FULL.

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

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

        public java.lang.Object 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 interface ChannelDataStoreInt
        Overrides:
        clone in class java.lang.Object
        Returns:
        the cloned instance of this BufferInt