jena-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a...@apache.org
Subject svn commit: r1512602 - in /jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib: BitsInt.java BitsLong.java
Date Sat, 10 Aug 2013 10:24:18 GMT
Author: andy
Date: Sat Aug 10 10:24:18 2013
New Revision: 1512602

URL: http://svn.apache.org/r1512602
Log:
Improve javadoc.

Modified:
    jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsInt.java
    jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsLong.java

Modified: jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsInt.java
URL: http://svn.apache.org/viewvc/jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsInt.java?rev=1512602&r1=1512601&r2=1512602&view=diff
==============================================================================
--- jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsInt.java (original)
+++ jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsInt.java Sat Aug 10 10:24:18
2013
@@ -21,16 +21,22 @@ package org.apache.jena.atlas.lib;
 // NB shifting is "mod 32" -- <<32 is a no-op (not a clear).
 // http://mindprod.com/jgloss/masking.html
 
-/** Utilities for manipulating a bit pattern which held in a 32 bit int */ 
+/** Utilities for manipulating a bit pattern which are held in a 32 bit int.
+ *  @see BitsLong
+ */ 
 public final class BitsInt
 {
     private BitsInt() {}
     
     private static int IntLen = Integer.SIZE ;
     
-    /** Extract the value packed into bits start (inclusive) and finish (exclusive),
-     *  the value is returned the low part of the returned int.
+    /** Extract the value packed into bits start (inclusive) and finish (exclusive).
+     *  The value is returned in the low part of the returned int.
      *  The low bit is bit zero.
+     * @param bits
+     * @param start
+     * @param finish
+     * @return int  
      */ 
     
     public static final
@@ -42,8 +48,13 @@ public final class BitsInt
         return (bits<<(IntLen-finish)) >>> ((IntLen-finish)+start) ;
     }
 
-    /** Place the value into the bit pattern between start and finish;
-     *  leaves other bits aint.
+    /** Place the value into the bit pattern between start and finish
+     *  and returns the new int. 
+     * @param bits
+     * @param value
+     * @param start
+     * @param finish
+     * @return int
      */
     public static final
     int pack(int bits, int value, int start, int finish)
@@ -138,6 +149,11 @@ public final class BitsInt
     /** Get the bits from start (inclusive) to finish (exclusive),
      *  leaving them aligned in the int.  See also unpack, returns
      *  the value found at that place.
+     *  @see #unpack(int, int, int)
+     *  @param bits
+     *  @param start
+     *  @param finish
+     *  @return int
      */
     
     public static final
@@ -147,6 +163,13 @@ public final class BitsInt
         return access$(bits, start, finish) ; 
     }
     
+    /**
+     * Clear the bits specified.
+     *  @param bits
+     *  @param start
+     *  @param finish
+     *  @return int
+     */
     public static final
     int clear(int bits, int start, int finish)
     {
@@ -155,7 +178,11 @@ public final class BitsInt
     }
 
     /**
-     * Create a mask that has ones between bit positions start (inc) and finish (exc)
+     * Create a mask that has ones between bit positions start (inc) and finish (exc),
+     * and zeros elsewhere.
+     * @param start
+     * @param finish
+     * @return int
      */
     public static final
     int mask(int start, int finish)
@@ -165,8 +192,11 @@ public final class BitsInt
     }
     
     /**
-     * Create a mask that has zeros between bit positions start (inc) and finish (exc)
+     * Create a mask that has zeros between bit positions start (inc) and finish (exc),
      * and ones elsewhere
+     * @param start
+     * @param finish
+     * @return int
      */
     public static final
     int maskZero(int start, int finish)
@@ -259,7 +289,6 @@ public final class BitsInt
     private static final
     int maskZero$(int start, int finish)
     {
-
         return ~mask$(start, finish) ;
     }
     

Modified: jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsLong.java
URL: http://svn.apache.org/viewvc/jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsLong.java?rev=1512602&r1=1512601&r2=1512602&view=diff
==============================================================================
--- jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsLong.java (original)
+++ jena/trunk/jena-arq/src/main/java/org/apache/jena/atlas/lib/BitsLong.java Sat Aug 10 10:24:18
2013
@@ -21,20 +21,23 @@ package org.apache.jena.atlas.lib;
 // NB shifting is "mod 64" -- <<64 is a no-op (not a clear).
 // http://mindprod.com/jgloss/masking.html
 
-/** Utilities for manipulating a bit pattern which held in a 64 bit long
+/** Utilities for manipulating a bit pattern which are held in a 64 bit long
+ *  @see BitsInt
  *  (java.util.BitSet does not allow getting the pattern as a long) 
  */ 
 public final class BitsLong
 {
     private BitsLong() {}
 
-    // When this is false, no calls to check() should be generated.
-    //public static final boolean CHECK = true ;
     private static int LongLen = Long.SIZE ;
     
     /** Extract the value packed into bits start (inclusive) and finish (exclusive),
      *  the value is returned the low part of the returned long.
      *  The low bit is bit zero.
+     * @param bits
+     * @param start
+     * @param finish
+     * @return long
      */ 
     
     public static final
@@ -46,8 +49,13 @@ public final class BitsLong
         return (bits<<(LongLen-finish)) >>> ((LongLen-finish)+start) ;
     }
 
-    /** Place the value into the bit pattern between start and finish;
-     *  leaves other bits alone.
+    /** Place the value into the bit pattern between start and finish
+     * and returns the new value.  Leaves other bits alone.
+     * @param bits
+     * @param value
+     * @param start
+     * @param finish
+     * @return long
      */
     public static final
     long pack(long bits, long value, int start, int finish)
@@ -143,7 +151,11 @@ public final class BitsLong
     /** Get the bits from start (inclusive) to finish (exclusive),
      *  leaving them aligned in the long.  See also unpack, returns
      *  the value found at that place.
-     */
+     *  @see #unpack(long, int, int)
+     *  @param bits
+     *  @param start
+     *  @param finish
+     *  @return lon     */
     
     public static final
     long access(long bits, int start, int finish)
@@ -152,7 +164,14 @@ public final class BitsLong
         return access$(bits, start, finish) ; 
     }
     
-    public static final
+    /**
+     * Clear the bits specified.
+     *  @param bits
+     *  @param start
+     *  @param finish
+     *  @return long
+     */
+  public static final
     long clear(long bits, int start, int finish)
     {
         check(start, finish) ;
@@ -160,7 +179,11 @@ public final class BitsLong
     }
 
     /**
-     * Create a mask that has ones between bit positions start (inc) and finish (exc)
+     * Create a mask that has ones between bit positions start (inc) and finish (exc),
+     * and zeros elsewhere.
+     * @param start
+     * @param finish
+     * @return long
      */
     public static final
     long mask(int start, int finish)
@@ -170,8 +193,11 @@ public final class BitsLong
     }
     
     /**
-     * Create a mask that has zeros between bit positions start (inc) and finish (exc)
+     * Create a mask that has zeros between bit positions start (inc) and finish (exc),
      * and ones elsewhere
+     * @param start
+     * @param finish
+     * @return long
      */
     public static final
     long maskZero(int start, int finish)



Mime
View raw message