Update Java Cursor API naming to reflect ByteArray semantics.

Also update documentation, to use Doxygen and @copydoc where possible.
Not yet tied into s_docs.
This commit is contained in:
Alex Gorrod
2013-02-19 17:06:41 +11:00
parent d6f5ed6237
commit 39150c640e
15 changed files with 540 additions and 200 deletions

View File

@@ -2,8 +2,10 @@ package com.wiredtiger.db;
import java.lang.String;
/*
* Package-private - not part of the public API.
/**
* An internal helper class with utilities for packing and unpacking values.
*
* Applications should not need to use this class.
*/
class PackUtil {
/* Contants. */
@@ -26,8 +28,12 @@ class PackUtil {
final static int SIZEOF_LONG = 8;
/*
* Extract bits <start> to <end> from a value (counting from LSB == 0).
/**
* Extract bits from a value, counting from LSB == 0.
*
* \param x The value to extract bits from.
* \param start The first bit to extract.
* \param end The last bit to extract.
*/
public static byte GET_BITS(long x, int start, int end) {
return (byte)((x & ((1 << start) - 1)) >> end);