Package org.jcsp.util

Class Buffer<T>

    • Constructor Detail

      • Buffer

        public Buffer​(int size)
        Construct a new Buffer with the specified size.
        Parameters:
        size - the number of Objects the Buffer can store.
        Throws:
        BufferSizeError - 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 T get()
        Returns the oldest Object from the Buffer and removes it.

        Pre-condition: getState must not currently return EMPTY.

        Specified by:
        get in interface ChannelDataStore<T>
        Returns:
        the oldest Object from the Buffer
      • startGet

        public T startGet()
        Returns the oldest object from the buffer but does not remove it. Pre-condition: getState must not currently return EMPTY.
        Specified by:
        startGet in interface ChannelDataStore<T>
        Returns:
        the oldest Object from the Buffer
        See Also:
        ChannelDataStore.endGet()
      • put

        public void put​(T value)
        Puts a new Object into the Buffer.

        Pre-condition: getState must not currently return FULL.

        Specified by:
        put in interface ChannelDataStore<T>
        Parameters:
        value - the Object to put into the Buffer
      • getState

        public int getState()
        Returns the current state of the Buffer.
        Specified by:
        getState in interface ChannelDataStore<T>
        Returns:
        the current state of the Buffer (EMPTY, NONEMPTYFULL or FULL)
      • clone

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

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

        Specified by:
        clone in interface ChannelDataStore<T>
        Overrides:
        clone in class Object
        Returns:
        the cloned instance of this Buffer