/*
 *  Copyright 2003-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.apache.commons.collections.buffer;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Collection;

import org.apache.commons.collections.Buffer;
import org.apache.commons.collections.BufferUnderflowException;

/**
 * Decorates another <code>Buffer</code> to make {@link #get()} and
 * {@link #remove()} block when the <code>Buffer</code> is empty.
 * <p/>
 * If either <code>get</code> or <code>remove</code> is called on an empty
 * <code>Buffer</code>, the calling thread waits for notification that
 * an <code>add</code> or <code>addAll</code> operation has completed.
 * <p/>
 * When one or more entries are added to an empty <code>Buffer</code>,
 * all threads blocked in <code>get</code> or <code>remove</code> are notified.
 * There is no guarantee that concurrent blocked <code>get</code> or
 * <code>remove</code> requests will be "unblocked" and receive data in the
 * order that they arrive.
 * <p/>
 * This class is Serializable from Commons Collections 3.1.
 *
 * @author Stephen Colebourne
 * @author Janek Bogucki
 * @author Phil Steitz
 * @version $Revision$ $Date$
 * @since Commons Collections 3.0
 */
public class BlockingBuffer extends SynchronizedBuffer {
    /**
     * Serialization version
     */
    private static final long serialVersionUID = 1719328905017860541L;

    /**
     * Factory method to create a blocking buffer.
     *
     * @param buffer the buffer to decorate, must not be null
     * @return a new blocking Buffer
     * @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);
            notifyAll();
            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) {
                    PrintWriter out = new PrintWriter(new StringWriter());
                    e.printStackTrace(out);
                    throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
                }
            }
            return getBuffer().get();
        }
    }

    public Object get(final long timeout) {
        synchronized(lock) {
            final long expiration = System.currentTimeMillis() + timeout;
            long timeLeft = expiration - System.currentTimeMillis();
            while(timeLeft > 0 && collection.isEmpty()) {
                try {
                    wait(timeLeft);
                    timeLeft = expiration - System.currentTimeMillis();
                }
                catch(InterruptedException e) {
                    PrintWriter out = new PrintWriter(new StringWriter());
                    e.printStackTrace(out);
                    throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
                }
            }
            if(collection.isEmpty()) {
                throw new BufferUnderflowException("Timeout expired.");
            }
            return getBuffer().get();
        }
    }

    public Object remove() {
        synchronized(lock) {
            while(collection.isEmpty()) {
                try {
                    wait();
                }
                catch(InterruptedException e) {
                    PrintWriter out = new PrintWriter(new StringWriter());
                    e.printStackTrace(out);
                    throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
                }
            }
            return getBuffer().remove();
        }
    }

    public Object remove(final long timeout) {
        synchronized(lock) {
            final long expiration = System.currentTimeMillis() + timeout;
            long timeLeft = expiration - System.currentTimeMillis();
            while(timeLeft > 0 && collection.isEmpty()) {
                try {
                    wait(timeLeft);
                    timeLeft = expiration - System.currentTimeMillis();
                }
                catch(InterruptedException e) {
                    PrintWriter out = new PrintWriter(new StringWriter());
                    e.printStackTrace(out);
                    throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
                }
            }
            if(collection.isEmpty()) {
                throw new BufferUnderflowException("Timeout expired.");
            }
            return getBuffer().remove();
        }
    }
}

@@ -1007,25 +1007,24 @@
 empty.%0A * %3Cp
-/
 %3E%0A * If eith
@@ -1231,25 +1231,24 @@
 leted.%0A * %3Cp
-/
 %3E%0A * When on
@@ -1565,17 +1565,16 @@
 e.%0A * %3Cp
-/
 %3E%0A * Thi
@@ -2756,32 +2756,33 @@
     synchronized
+ 
 (lock) %7B%0A       
@@ -2945,32 +2945,33 @@
     synchronized
+ 
 (lock) %7B%0A       
@@ -3121,32 +3121,33 @@
     synchronized
+ 
 (lock) %7B%0A       
@@ -3148,32 +3148,33 @@
            while
+ 
 (collection.isEm
@@ -3249,38 +3249,23 @@
        %7D
-%0A               
  catch
+ 
 (Interru
@@ -3654,32 +3654,33 @@
     synchronized
+ 
 (lock) %7B%0A       
@@ -3824,32 +3824,33 @@
            while
+ 
 (timeLeft %3E 0 &&
@@ -4021,32 +4021,16 @@
        %7D
-%0A               
  catch(I
@@ -4320,32 +4320,33 @@
 %7D%0A            if
+ 
 (collection.isEm
@@ -4536,32 +4536,33 @@
     synchronized
+ 
 (lock) %7B%0A       
@@ -4571,16 +4571,17 @@
    while
+ 
 (collect
@@ -4664,38 +4664,23 @@
        %7D
-%0A               
  catch
+ 
 (Interru
@@ -5083,16 +5083,17 @@
 hronized
+ 
 (lock) %7B
@@ -5253,16 +5253,17 @@
    while
+ 
 (timeLef
@@ -5442,32 +5442,16 @@
        %7D
-%0A               
  catch(I
@@ -5749,16 +5749,17 @@
       if
+ 
 (collect
@@ -5918,10 +5918,11 @@
 %7D%0A    %7D%0A
+%0A
 %7D%0A

Fix formatting issues from previous commit