svn commit: r762170 - in /mina/trunk/core/src/main/java/org/apache/mina: filter/executor/IoEventQueueThrottle.java util/CircularQueue.java

[el...@apache.org]

Author: elecharny
Date: Sun Apr  5 22:01:18 2009
New Revision: 762170

URL: http://svn.apache.org/viewvc?rev=762170&view=rev
Log:
Minor refactoring and Javadoc addition

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
    mina/trunk/core/src/main/java/org/apache/mina/util/CircularQueue.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java?rev=762170&r1=762169&r2=762170&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java Sun Apr  5 22:01:18 2009
@@ -32,10 +32,12 @@
  * @version $Rev$, $Date$
  */
 public class IoEventQueueThrottle implements IoEventQueueHandler {
-
+    /** A logger for this class */
     private final Logger logger = LoggerFactory.getLogger(getClass());
 
+    /** The event size estimator instance */
     private final IoEventSizeEstimator eventSizeEstimator;
+    
     private volatile int threshold;
 
     private final Object lock = new Object();

Modified: mina/trunk/core/src/main/java/org/apache/mina/util/CircularQueue.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/util/CircularQueue.java?rev=762170&r1=762169&r2=762170&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/util/CircularQueue.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/util/CircularQueue.java Sun Apr  5 22:01:18 2009
@@ -33,12 +33,15 @@
  * @version $Rev$, $Date$
  */
 public class CircularQueue<E> extends AbstractList<E> implements List<E>, Queue<E>, Serializable {
-
+    /** The serialVersionUID : mandatory for serializable classes */
     private static final long serialVersionUID = 3993421269224511264L;
 
+    /** Minimal size fo the underlying attay */
     private static final int DEFAULT_CAPACITY = 4;
 
+    /** The initial capacity of the list */
     private final int initialCapacity;
+    
     // XXX: This volatile keyword here is a workaround for SUN Java Compiler bug,
     //      which produces buggy byte code.  I don't event know why adding a volatile
     //      fixes the problem.  Eclipse Java Compiler seems to produce correct byte code.
@@ -64,8 +67,12 @@
         this.shrinkThreshold = 0;
     }
 
+    /**
+     * The capacity must be a power of 2.
+     */
     private static int normalizeCapacity(int initialCapacity) {
         int actualCapacity = 1;
+        
         while (actualCapacity < initialCapacity) {
             actualCapacity <<= 1;
             if (actualCapacity < 0) {
@@ -116,6 +123,7 @@
         if (item == null) {
             throw new NullPointerException("item");
         }
+        
         expandIfNeeded();
         items[last] = item;
         increaseSize();