Stylistic changes

- Moved constructor up
- Javadoc added
- inner class is now static
- Added logger attribute

core/src/main/java/com/turn/ttorrent/common/ByteBufferPool.java

@@ -5,21 +5,29 @@
 import org.apache.commons.pool2.impl.DefaultPooledObject;
 import org.apache.commons.pool2.impl.GenericObjectPool;
 import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.nio.ByteBuffer;
 
 public class ByteBufferPool {
 
-    private final GenericObjectPool<ByteBuffer> pool;
-
-    public ByteBuffer borrowObject() throws Exception {
-        return pool.borrowObject();
-    }
+    private static final Logger logger =
+            LoggerFactory.getLogger(ByteBufferPool.class);
 
-    public void returnObject(ByteBuffer buffer) {
-        pool.returnObject(buffer);
-    }
+    private final GenericObjectPool<ByteBuffer> pool;
 
+    /**
+     * A limited pool of buffers, so that:
+     *
+     *  - We don't thrash the memory with a lot of short-lived objects
+     *  - We don't use a lot of memory when we're ingesting a huge amount of data
+     *
+     * The ByteBuffers are array backed, so the APIs they get sent to have no need to instantiate one
+     *
+     * @param amount The exact amount of buffers this pool will hold
+     * @param length The legth of each buffer in this pool
+     */
     public ByteBufferPool(int amount, int length) {
         final GenericObjectPoolConfig gopc = new GenericObjectPoolConfig();
         gopc.setMinIdle(amount);
@@ -28,7 +36,15 @@ public ByteBufferPool(int amount, int length) {
         pool = new GenericObjectPool<ByteBuffer>(new ByteBufferFactory(length), gopc);
     }
 
-    private class ByteBufferFactory extends BasePooledObjectFactory<ByteBuffer> {
+    public ByteBuffer borrowObject() throws Exception {
+        return pool.borrowObject();
+    }
+
+    public void returnObject(ByteBuffer buffer) {
+        pool.returnObject(buffer);
+    }
+
+    private static class ByteBufferFactory extends BasePooledObjectFactory<ByteBuffer> {
         private final int length;
 
         private ByteBufferFactory(int length) {