svn commit: r1077486 - /cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java

[jbellis]

Author: jbellis
Date: Fri Mar  4 04:19:58 2011
New Revision: 1077486

URL: http://svn.apache.org/viewvc?rev=1077486&view=rev
Log:
javadoc for BBU.clone

Modified:
    
cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java

Modified: 
cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
URL: 
http://svn.apache.org/viewvc/cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java?rev=1077486&r1=1077485&r2=1077486&view=diff
==============================================================================
--- 
cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
 (original)
+++ 
cassandra/branches/cassandra-0.7/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
 Fri Mar  4 04:19:58 2011
@@ -188,23 +188,28 @@ public class ByteBufferUtil
            throw new RuntimeException(e);
         } 
     }
-    
-    public static ByteBuffer clone(ByteBuffer o)
+
+    /**
+     * @return a new copy of the data in @param buffer
+     * USUALLY YOU SHOULD USE ByteBuffer.duplicate() INSTEAD, which creates a 
new Buffer
+     * (so you can mutate its position without affecting the original) without 
copying the underlying array.
+     */
+    public static ByteBuffer clone(ByteBuffer buffer)
     {
-        assert o != null;
+        assert buffer != null;
         
-        if (o.remaining() == 0)
+        if (buffer.remaining() == 0)
             return EMPTY_BYTE_BUFFER;
           
-        ByteBuffer clone = ByteBuffer.allocate(o.remaining());
+        ByteBuffer clone = ByteBuffer.allocate(buffer.remaining());
 
-        if (o.hasArray())
+        if (buffer.hasArray())
         {
-            System.arraycopy(o.array(), o.arrayOffset() + o.position(), 
clone.array(), 0, o.remaining());
+            System.arraycopy(buffer.array(), buffer.arrayOffset() + 
buffer.position(), clone.array(), 0, buffer.remaining());
         }
         else
         {
-            clone.put(o.duplicate());
+            clone.put(buffer.duplicate());
             clone.flip();
         }