Class PredicatedBuffer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable, java.util.Collection, Buffer

    @Deprecated(since="2021-04-30")
    public class PredicatedBuffer
    extends PredicatedCollection
    implements Buffer
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Decorates another Buffer to validate that additions match a specified predicate.

    This buffer exists to provide validation for the decorated buffer. It is normally created to decorate an empty buffer. If an object cannot be added to the buffer, an IllegalArgumentException is thrown.

    One usage would be to ensure that no null entries are added to the buffer.

    Buffer buffer = PredicatedBuffer.decorate(new UnboundedFifoBuffer(), NotNullPredicate.INSTANCE);

    This class is Serializable from Commons Collections 3.1.

    Since:
    Commons Collections 3.0
    See Also:
    Serialized Form
    • Method Detail

      • decorate

        public static Buffer decorate​(Buffer buffer,
                                      Predicate predicate)
        Deprecated.
        Factory method to create a predicated (validating) buffer.

        If there are any elements already in the buffer being decorated, they are validated.

        Parameters:
        buffer - the buffer to decorate, must not be null
        predicate - the predicate to use for validation, must not be null
        Returns:
        a new predicated Buffer
        Throws:
        java.lang.IllegalArgumentException - if buffer or predicate is null
        java.lang.IllegalArgumentException - if the buffer contains invalid elements
      • get

        public java.lang.Object get()
        Deprecated.
        Description copied from interface: Buffer
        Gets the next object from the buffer without removing it.
        Specified by:
        get in interface Buffer
        Returns:
        the next object in the buffer, which is not removed
      • remove

        public java.lang.Object remove()
        Deprecated.
        Description copied from interface: Buffer
        Gets and removes the next object from the buffer.
        Specified by:
        remove in interface Buffer
        Returns:
        the next object in the buffer, which is also removed