svn commit: r762172 - /mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java

[el...@apache.org]

Author: elecharny
Date: Sun Apr  5 22:04:36 2009
New Revision: 762172

URL: http://svn.apache.org/viewvc?rev=762172&view=rev
Log:
Added some javadoc

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java?rev=762172&r1=762171&r2=762172&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/filter/executor/DefaultIoEventSizeEstimator.java Sun Apr  5 22:04:36 2009
@@ -45,9 +45,13 @@
  * @version $Rev$, $Date$
  */
 public class DefaultIoEventSizeEstimator implements IoEventSizeEstimator {
-
+    /** A map containing the estimated size of each Java objects we know for */ 
     private final ConcurrentMap<Class<?>, Integer> class2size = new ConcurrentHashMap<Class<?>, Integer>();
 
+    /**
+     * Create a new instance of this class, injecting the known size of 
+     * basic java types.
+     */
     public DefaultIoEventSizeEstimator() {
         class2size.put(boolean.class, 4); // Probably an integer.
         class2size.put(byte.class, 1);
@@ -60,10 +64,18 @@
         class2size.put(void.class, 0);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public int estimateSize(IoEvent event) {
         return estimateSize((Object) event) + estimateSize(event.getParameter());
     }
 
+    /**
+     * Estimate the size of an Objecr in number of bytes
+     * @param message The object to estimate
+     * @return The estimated size of the object
+     */
     public int estimateSize(Object message) {
         if (message == null) {
             return 8;