BlockingBuffer decorates another Buffer
+ * to block on calls to the get method to wait until entries are
+ * added to the buffer.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/05/07 12:19:26 $
+ *
+ * @author Stephen Colebourne
+ */
+public class BlockingBuffer extends SynchronizedBuffer {
+
+ /**
+ * Factory method to create a blocking buffer.
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if buffer is null
+ */
+ public static Buffer decorate(Buffer buffer) {
+ return new BlockingBuffer(buffer);
+ }
+
+ /**
+ * Constructor that wraps (not copies).
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if the buffer is null
+ */
+ protected BlockingBuffer(Buffer buffer) {
+ super(buffer);
+ }
+
+ //-----------------------------------------------------------------------
+ public boolean add(Object o) {
+ synchronized (lock) {
+ boolean result = collection.add(o);
+ notify();
+ return result;
+ }
+ }
+
+ public boolean addAll(Collection c) {
+ synchronized (lock) {
+ boolean result = collection.addAll(c);
+ notifyAll();
+ return result;
+ }
+ }
+
+ public Object get() {
+ synchronized (lock) {
+ while (collection.isEmpty()) {
+ try {
+ wait();
+ } catch (InterruptedException e) {
+ throw new BufferUnderflowException();
+ }
+ }
+ return getBuffer().get();
+ }
+ }
+
+ public Object remove() {
+ synchronized (lock) {
+ while (collection.isEmpty()) {
+ try {
+ wait();
+ } catch (InterruptedException e) {
+ throw new BufferUnderflowException();
+ }
+ }
+ return getBuffer().remove();
+ }
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/decorators/PredicatedBuffer.java b/src/java/org/apache/commons/collections/decorators/PredicatedBuffer.java
new file mode 100644
index 000000000..6bea39fc5
--- /dev/null
+++ b/src/java/org/apache/commons/collections/decorators/PredicatedBuffer.java
@@ -0,0 +1,126 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/PredicatedBuffer.java,v 1.1 2003/05/07 12:19:26 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgment:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgment may appear in the software itself,
+ * if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * PredicatedBuffer decorates another Buffer
+ * to validate additions match a specified predicate.
+ * + * If an object cannot be addded to the collection, an IllegalArgumentException + * is thrown. + * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/05/07 12:19:26 $ + * + * @author Stephen Colebourne + * @author Paul Jack + */ +public class PredicatedBuffer extends PredicatedCollection implements Buffer { + + /** + * Factory method to create a predicated (validating) buffer. + *
+ * If there are any elements already in the buffer being decorated, they + * are validated. + * + * @param buffer the buffer to decorate, must not be null + * @param predicate the predicate to use for validation, must not be null + * @throws IllegalArgumentException if buffer or predicate is null + * @throws IllegalArgumentException if the buffer contains invalid elements + */ + public static Buffer decorate(Buffer buffer, Predicate predicate) { + return new PredicatedBuffer(buffer, predicate); + } + + /** + * Constructor that wraps (not copies). + *
+ * If there are any elements already in the collection being decorated, they
+ * are validated.
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @param predicate the predicate to use for validation, must not be null
+ * @throws IllegalArgumentException if buffer or predicate is null
+ * @throws IllegalArgumentException if the buffer contains invalid elements
+ */
+ protected PredicatedBuffer(Buffer buffer, Predicate predicate) {
+ super(buffer, predicate);
+ }
+
+ /**
+ * Gets the buffer being decorated.
+ *
+ * @return the decorated buffer
+ */
+ protected Buffer getBuffer() {
+ return (Buffer) getCollection();
+ }
+
+ //-----------------------------------------------------------------------
+ public Object get() {
+ return getBuffer().get();
+ }
+
+ public Object remove() {
+ return getBuffer().remove();
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedBuffer.java b/src/java/org/apache/commons/collections/decorators/SynchronizedBuffer.java
new file mode 100644
index 000000000..417e94126
--- /dev/null
+++ b/src/java/org/apache/commons/collections/decorators/SynchronizedBuffer.java
@@ -0,0 +1,128 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedBuffer.java,v 1.1 2003/05/07 12:19:26 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgment:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgment may appear in the software itself,
+ * if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * SynchronizedBuffer decorates another Buffer
+ * to synchronize its behaviour for a multi-threaded environment.
+ *
+ * Methods are synchronized, then forwarded to the decorated buffer.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/05/07 12:19:26 $
+ *
+ * @author Stephen Colebourne
+ */
+public class SynchronizedBuffer extends SynchronizedCollection implements Buffer {
+
+ /**
+ * Factory method to create a synchronized buffer.
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if buffer is null
+ */
+ public static Buffer decorate(Buffer buffer) {
+ return new SynchronizedBuffer(buffer);
+ }
+
+ /**
+ * Constructor that wraps (not copies).
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if the buffer is null
+ */
+ protected SynchronizedBuffer(Buffer buffer) {
+ super(buffer);
+ }
+
+ /**
+ * Constructor that wraps (not copies).
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @param lock the lock object to use, must not be null
+ * @throws IllegalArgumentException if the buffer is null
+ */
+ protected SynchronizedBuffer(Buffer buffer, Object lock) {
+ super(buffer, lock);
+ }
+
+ /**
+ * Gets the buffer being decorated.
+ *
+ * @return the decorated buffer
+ */
+ protected Buffer getBuffer() {
+ return (Buffer) collection;
+ }
+
+ //-----------------------------------------------------------------------
+ public Object get() {
+ synchronized (lock) {
+ return getBuffer().get();
+ }
+ }
+
+ public Object remove() {
+ synchronized (lock) {
+ return getBuffer().remove();
+ }
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/decorators/UnmodifiableBuffer.java b/src/java/org/apache/commons/collections/decorators/UnmodifiableBuffer.java
new file mode 100644
index 000000000..8b6f264c4
--- /dev/null
+++ b/src/java/org/apache/commons/collections/decorators/UnmodifiableBuffer.java
@@ -0,0 +1,111 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableBuffer.java,v 1.1 2003/05/07 12:19:26 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgment:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgment may appear in the software itself,
+ * if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * UnmodifiableBuffer decorates another Buffer
+ * to ensure it can't be altered.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/05/07 12:19:26 $
+ *
+ * @author Stephen Colebourne
+ */
+public class UnmodifiableBuffer extends UnmodifiableCollection implements Buffer {
+
+ /**
+ * Factory method to create an unmodifiable buffer.
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if buffer is null
+ */
+ public static Buffer decorate(Buffer buffer) {
+ return new UnmodifiableBuffer(buffer);
+ }
+
+ /**
+ * Constructor that wraps (not copies).
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @throws IllegalArgumentException if buffer is null
+ */
+ protected UnmodifiableBuffer(Buffer buffer) {
+ super(buffer);
+ }
+
+ /**
+ * Gets the buffer being decorated.
+ *
+ * @return the decorated buffer
+ */
+ protected Buffer getBuffer() {
+ return (Buffer) getCollection();
+ }
+
+ //-----------------------------------------------------------------------
+ public Object get() {
+ return getBuffer().get();
+ }
+
+ public Object remove() {
+ throw new UnsupportedOperationException();
+ }
+
+}