Author: scolebourne
Date: Sun Nov 13 08:23:35 2005
New Revision: 333048
URL: http://svn.apache.org/viewcvs?rev=333048&view=rev
Log:
Tidy up formatting and tests afetr initial checkin
Modified:
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/TimeoutBuffer.java
jakarta/commons/proper/collections/trunk/src/test/org/apache/commons/collections/buffer/TestTimeoutBuffer.java
Modified:
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/TimeoutBuffer.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/TimeoutBuffer.java?rev=333048&r1=333047&r2=333048&view=diff
==============================================================================
---
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/TimeoutBuffer.java
(original)
+++
jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/TimeoutBuffer.java
Sun Nov 13 08:23:35 2005
@@ -1,5 +1,5 @@
/*
- * Copyright 2001-2005 The Apache Software Foundation
+ * Copyright 2005 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.
@@ -16,88 +16,96 @@
package org.apache.commons.collections.buffer;
import org.apache.commons.collections.Buffer;
+import org.apache.commons.collections.BufferUnderflowException;
/**
* Decorates another <code>Buffer</code> to make [EMAIL PROTECTED] #get()} and
- * [EMAIL PROTECTED] #remove()} block (until timeout expires) when the
<code>Buffer</code> is empty.
+ * [EMAIL PROTECTED] #remove()} block (until timeout expires) 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 (until timeout expires) for
notification that
- * an <code>add</code> or <code>addAll</code> operation has completed.
+ * <code>Buffer</code>, the calling thread waits (until timeout expires) 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.
+ * 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.2.
- *
+ *
* @author James Carman
- * @version $Revision$ $Date$
+ * @version $Revision: $ $Date: $
* @since Commons Collections 3.2
*/
public class TimeoutBuffer extends BlockingBuffer {
-//----------------------------------------------------------------------------------------------------------------------
-// Fields
-//----------------------------------------------------------------------------------------------------------------------
+
+ /** The serialization lock. */
private static final long serialVersionUID = 1719328905017860541L;
+ /** The timeout length. */
private final long timeout;
-//----------------------------------------------------------------------------------------------------------------------
-// Static Methods
-//----------------------------------------------------------------------------------------------------------------------
-
- public static Buffer decorate( Buffer buffer, long timeout ) {
- return new TimeoutBuffer( buffer, timeout );
- }
-
-//----------------------------------------------------------------------------------------------------------------------
-// Constructors
-//----------------------------------------------------------------------------------------------------------------------
-
- public TimeoutBuffer( Buffer buffer, long timeout ) {
- super( buffer );
+ /**
+ * Decorates the specified buffer adding timeout behaviour.
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @param timeout the timeout value in milliseconds
+ * @return the decorated buffer
+ * @throws IllegalArgumentException if the buffer is null
+ * @throws IllegalArgumentException if the timeout is negative
+ */
+ public static Buffer decorate(Buffer buffer, long timeout) {
+ return new TimeoutBuffer(buffer, timeout);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Constructor that wraps (not copies).
+ *
+ * @param buffer the buffer to decorate, must not be null
+ * @param timeout the timeout value in milliseconds
+ * @throws IllegalArgumentException if the buffer is null
+ * @throws IllegalArgumentException if the timeout is negative
+ */
+ protected TimeoutBuffer(Buffer buffer, long timeout) {
+ super(buffer);
+ if (timeout < 0) {
+ throw new IllegalArgumentException("The timeout cannot be
negative");
+ }
this.timeout = timeout;
}
+ /**
+ * Gets the length of the timeout.
+ *
+ * @return the timeout value
+ */
public long getTimeout() {
return timeout;
}
-//----------------------------------------------------------------------------------------------------------------------
-// Buffer Implementation
-//----------------------------------------------------------------------------------------------------------------------
+ //-----------------------------------------------------------------------
+ /**
+ * Gets the next value from the buffer, waiting until an object is
+ * added for up to the specified timeout value if the buffer is empty.
+ *
+ * @throws BufferUnderflowException if an interrupt is received
+ * @throws BufferUnderflowException if the timeout expires
+ */
public Object get() {
- return get( timeout );
+ return get(timeout);
}
+ /**
+ * Removes the next value from the buffer, waiting until an object is
+ * added for up to the specified timeout value if the buffer is empty.
+ *
+ * @throws BufferUnderflowException if an interrupt is received
+ * @throws BufferUnderflowException if the timeout expires
+ */
public Object remove() {
- return remove( timeout );
+ return remove(timeout);
}
- public boolean equals( Object o ) {
- if( this == o ) {
- return true;
- }
- if( o == null || getClass() != o.getClass() ) {
- return false;
- }
- if( !super.equals( o ) ) {
- return false;
- }
- final TimeoutBuffer that = ( TimeoutBuffer ) o;
- if( timeout != that.timeout ) {
- return false;
- }
- return true;
- }
-
- public int hashCode() {
- int result = super.hashCode();
- result = 29 * result + ( int ) ( timeout ^ ( timeout >>> 32 ) );
- return result;
- }
}
-
Modified:
jakarta/commons/proper/collections/trunk/src/test/org/apache/commons/collections/buffer/TestTimeoutBuffer.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/collections/trunk/src/test/org/apache/commons/collections/buffer/TestTimeoutBuffer.java?rev=333048&r1=333047&r2=333048&view=diff
==============================================================================
---
jakarta/commons/proper/collections/trunk/src/test/org/apache/commons/collections/buffer/TestTimeoutBuffer.java
(original)
+++
jakarta/commons/proper/collections/trunk/src/test/org/apache/commons/collections/buffer/TestTimeoutBuffer.java
Sun Nov 13 08:23:35 2005
@@ -55,6 +55,20 @@
//----------------------------------------------------------------------------------------------------------------------
// Other Methods
//----------------------------------------------------------------------------------------------------------------------
+ public void testDecorationExceptions() {
+ try {
+ TimeoutBuffer.decorate((Buffer) null, 1);
+ fail();
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ try {
+ TimeoutBuffer.decorate(new CircularFifoBuffer(4), -1);
+ fail();
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ }
public String getCompatibilityVersion() {
return "3.2";
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
