Class BufferInt

    • 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 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 Object
        Returns:
        the cloned instance of this BufferInt