-DatabaseEntry (Oracle - Berkeley DB Java API) -

java.lang.Object
+
- com.sleepycat.db.DatabaseEntry
+

+
+
Direct Known Subclasses:
+
MultipleEntry
+
+
+
+
```
public class DatabaseEntry
+extends java.lang.Object
```
+
Encodes database key and data items as a byte array.
-Storage and retrieval for the Database and Cursor methods +Storage and retrieval for the Database and Cursor methods are based on key/data pairs. Both key and data items are represented by DatabaseEntry objects. Key and data byte arrays may refer to arrays of zero length up to arrays of essentially unlimited length. @@ -118,10 +117,10 @@ references to other structures.
Access to DatabaseEntry objects is not re-entrant. In particular, if multiple threads simultaneously access the same DatabaseEntry object using -Database or Cursor methods, the results are undefined. +Database or Cursor methods, the results are undefined.
DatabaseEntry objects may be used in conjunction with the object mapping -support provided in the com.sleepycat.bind package. +support provided in the com.sleepycat.bind package.

Input and Output Parameters

@@ -129,7 +128,7 @@ DatabaseEntry objects are used for both input data (when writing to a database or specifying a search parameter) and output data (when reading from a database). For certain methods, one parameter may be an input parameter and another may be an output parameter. For example, the -Database.get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode) method has an input key parameter and an output +Database.get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode) method has an input key parameter and an output data parameter. The documentation for each method describes whether its parameters are input or output parameters.
@@ -139,15 +138,15 @@ output parameters, the method called will initialize the data array.
For DatabaseEntry output parameters, by default the method called will reuse the byte array in the DatabaseEntry, if the data returned fits in -the byte array. This behavior can be configured with setReuseBuffer(boolean) or setUserBuffer(int, boolean). If an entry is configured to +the byte array. This behavior can be configured with setReuseBuffer(boolean) or setUserBuffer(int, boolean). If an entry is configured to reuse the byte array (the default behavior), the length of the underlying byte array should not be used to determine the amount of data returned each -time the entry is used as an output parameter, rather the getSize() +time the entry is used as an output parameter, rather the getSize() call should be used. If an entry is configured to not reuse the byte array, a new array is allocated each time the entry is used as an output parameter, so the application can safely keep a reference to the byte array returned -by getData() without danger that the array will be overwritten in +by getData() without danger that the array will be overwritten in a subsequent call.

Offset and Size Properties
@@ -181,662 +180,608 @@ By default the specified data (byte array, offset and size) corresponds to the full stored key or data item. Optionally, the Partial property can be set to true, and the PartialOffset and PartialLength properties are used to specify the portion of the key or data item to be read or written. For -details, see the setPartial(int,int,boolean) method. +details, see the setPartial(int,int,boolean) method.
Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method, nor will they every be set by bindings. Therefore, the application can assume that the Partial properties -are not set, unless the application itself sets them explicitly. -
- -
-
- -
- +are not set, unless the application itself sets them explicitly.
+

- - - - - - - - - - - - - - - - - - -

-Constructor Summary
`DatabaseEntry()` - - - Construct a DatabaseEntry with null data.
`DatabaseEntry(byte[] data)` - - - Construct a DatabaseEntry with a given byte array.
`DatabaseEntry(byte[] data, - int offset, - int size)` - - - Constructs a DatabaseEntry with a given byte array, offset and size.
`DatabaseEntry(ByteBuffer data)` - - - Construct a DatabaseEntry with a given native I/O buffer.

- +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`DatabaseEntry()` + Construct a DatabaseEntry with null data. +
`DatabaseEntry(byte[] data)` + Construct a DatabaseEntry with a given byte array. +
`DatabaseEntry(byte[] data, + int offset, + int size)` + Constructs a DatabaseEntry with a given byte array, offset and size. +
`DatabaseEntry(java.nio.ByteBuffer data)` + Construct a DatabaseEntry with a given native I/O buffer. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Method Summary
- `boolean`	`equals(Object o)` - - - Compares the data of two entries for byte-by-byte equality.
- `byte[]`	`getData()` - - - Return the byte array.
- `ByteBuffer`	`getDataNIO()` - - - Return the java.nio.ByteBuffer.
- `int`	`getOffset()` - - - Return the byte offset into the data array.
- `boolean`	`getPartial()` - - - Return whether this DatabaseEntry is configured to read or write partial - records.
- `int`	`getPartialLength()` - - - Return the byte length of the partial record being read or written by - the application, in bytes.
- `int`	`getPartialOffset()` - - - Return the offset of the partial record being read or written by the - application, in bytes.
- `boolean`	`getReadOnly()` - - - Return whether this DatabaseEntry is configured as read only.
- `int`	`getRecordNumber()` - - - Return the record number encoded in this entry's buffer.
- `boolean`	`getReuseBuffer()` - - - Return true if the whether the entry is configured to reuse the buffer.
- `int`	`getSize()` - - - Return the byte size of the data array.
- `boolean`	`getUserBuffer()` - - - Return true if the whether the buffer in this entry is owned by the - application.
- `int`	`getUserBufferLength()` - - - Return the length of the application's buffer.
- `int`	`hashCode()` - - - Returns a hash code based on the data value.
- `void`	`setData(byte[] data)` - - - Sets the byte array.
- `void`	`setData(byte[] data, - int offset, - int size)` - - - Sets the byte array, offset and size.
- `void`	`setDataNIO(ByteBuffer data)` - - - Sets the java.nio.ByteBuffer.
- `void`	`setDataNIO(ByteBuffer data, - int offset, - int size)` - - - Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct - ByteBuffer,) offset and size.
- `void`	`setOffset(int offset)` - - - Set the byte offset into the data array.
- `void`	`setPartial(boolean partial)` - - - Configure this DatabaseEntry to read or write partial records.
- `void`	`setPartial(int doff, - int dlen, - boolean partial)` - - - Configures this DatabaseEntry to read or write partial records.
- `void`	`setPartialLength(int dlen)` - - - Set the byte length of the partial record being read or written by - the application, in bytes.
- `void`	`setPartialOffset(int doff)` - - - Set the offset of the partial record being read or written by the - application, in bytes.
- `void`	`setReadOnly(boolean readonly)` - - - Configure this DatabaseEntry as read only.
- `void`	`setRecordNumber(int recno)` - - - Initialize the entry from a logical record number.
- `void`	`setReuseBuffer(boolean reuse)` - - - Configures the entry to try to reuse the buffer before allocating a new - one.
- `void`	`setSize(int size)` - - - Set the byte size of the data array.
- `void`	`setUserBuffer(int length, - boolean usermem)` - - - Configures the entry with an application-owned buffer.

- - - - - - - - -

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- -

- +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` + Compares the data of two entries for byte-by-byte equality. +
`boolean`	`getBlob()` + Return whether this DatabaseEntry is configured to be stored as a blob. +
`byte[]`	`getData()` + Return the byte array. +
`java.nio.ByteBuffer`	`getDataNIO()` + Return the java.nio.ByteBuffer. +
`int`	`getOffset()` + Return the byte offset into the data array. +
`boolean`	`getPartial()` + Return whether this DatabaseEntry is configured to read or write partial + records. +
`int`	`getPartialLength()` + Return the byte length of the partial record being read or written by + the application, in bytes. +
`int`	`getPartialOffset()` + Return the offset of the partial record being read or written by the + application, in bytes. +
`boolean`	`getReadOnly()` + Return whether this DatabaseEntry is configured as read only. +
`int`	`getRecordNumber()` + Return the record number encoded in this entry's buffer. +
`boolean`	`getReuseBuffer()` + Return true if the whether the entry is configured to reuse the buffer. +
`int`	`getSize()` + Return the byte size of the data array. +
`boolean`	`getUserBuffer()` + Return true if the whether the buffer in this entry is owned by the + application. +
`int`	`getUserBufferLength()` + Return the length of the application's buffer. +
`int`	`hashCode()` + Returns a hash code based on the data value. +
`void`	`setBlob(boolean blob)` + Configure this DatabaseEntry to be stored as a blob. +
`void`	`setData(byte[] data)` + Sets the byte array. +
`void`	`setData(byte[] data, + int offset, + int size)` + Sets the byte array, offset and size. +
`void`	`setDataNIO(java.nio.ByteBuffer data)` + Sets the java.nio.ByteBuffer. +
`void`	`setDataNIO(java.nio.ByteBuffer data, + int offset, + int size)` + Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct + ByteBuffer,) offset and size. +
`void`	`setOffset(int offset)` + Set the byte offset into the data array. +
`void`	`setPartial(boolean partial)` + Configure this DatabaseEntry to read or write partial records. +
`void`	`setPartial(int doff, + int dlen, + boolean partial)` + Configures this DatabaseEntry to read or write partial records. +
`void`	`setPartialLength(int dlen)` + Set the byte length of the partial record being read or written by + the application, in bytes. +
`void`	`setPartialOffset(int doff)` + Set the offset of the partial record being read or written by the + application, in bytes. +
`void`	`setReadOnly(boolean readonly)` + Configure this DatabaseEntry as read only. +
`void`	`setRecordNumber(int recno)` + Initialize the entry from a logical record number. +
`void`	`setReuseBuffer(boolean reuse)` + Configures the entry to try to reuse the buffer before allocating a new + one. +
`void`	`setSize(int size)` + Set the byte size of the data array. +
`void`	`setUserBuffer(int length, + boolean usermem)` + Configures the entry with an application-owned buffer. +

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- - - - - - -
-Constructor Detail
- -
-DatabaseEntry
-
```
-public DatabaseEntry()
```
-
-
Construct a DatabaseEntry with null data. The offset and size are set to - zero. -
-
-
- -
-DatabaseEntry
-
```
-public DatabaseEntry(byte[] data)
```
-
-
Construct a DatabaseEntry with a given byte array. The offset is +
- + + +
  Constructor Detail
  + + + +
  - +
    DatabaseEntry
    +
    public DatabaseEntry()
    +
    Construct a DatabaseEntry with null data. The offset and size are set to + zero.
    +
  + + + +
  - +
    DatabaseEntry
    +
    public DatabaseEntry(byte[] data)
    +
    Construct a DatabaseEntry with a given byte array. The offset is set to zero; the size is set to the length of the array, or to zero if null is passed. -
    -
    -
    -
    Parameters:
    data - Byte array wrapped by the DatabaseEntry.
    -
-
- -
-DatabaseEntry
-
```
-public DatabaseEntry(byte[] data,
-                     int offset,
-                     int size)
```
-
-
Constructs a DatabaseEntry with a given byte array, offset and size. -
-
-
-
Parameters:
data - Byte array wrapped by the DatabaseEntry.
offset - Offset in the first byte in the byte array to be included.
size - Number of bytes in the byte array to be included.
-
-
- -
-DatabaseEntry
-
```
-public DatabaseEntry(ByteBuffer data)
```
-
-
Construct a DatabaseEntry with a given native I/O buffer. If the buffer is +

Parameters:: data - Byte array wrapped by the DatabaseEntry.

+ + + + + +

+
DatabaseEntry
+
```
public DatabaseEntry(byte[] data,
+             int offset,
+             int size)
```
+
Constructs a DatabaseEntry with a given byte array, offset and size. +
+
Parameters:
data - Byte array wrapped by the DatabaseEntry.
offset - Offset in the first byte in the byte array to be included.
size - Number of bytes in the byte array to be included.
+

+ + + +

+
DatabaseEntry
+
```
public DatabaseEntry(java.nio.ByteBuffer data)
```
+
Construct a DatabaseEntry with a given native I/O buffer. If the buffer is non-direct, the buffer's backing array is used. If the buffer is direct, the DatabaseEntry is configured with an application-owned buffer whose length is set to the ByteBuffer's capacity less its position. The DatabaseEntry's size is set to the ByteBuffer's limit less its position and the offset is set to buffer's position (adjusted by arrayOffset if the buffer is non-direct.) -
-
-
-
Parameters:
data - NIO byte buffer wrapped by the DatabaseEntry.
- - +
+
Parameters:
data - NIO byte buffer wrapped by the DatabaseEntry.
+

+ + - - - - - - -

-Method Detail

- -

-getData

-public byte[] getData()

Return the byte array. +

+ + +
Method Detail
+ + + +
- +
  setBlob
  +
```
public void setBlob(boolean blob)
```
  +
  Configure this DatabaseEntry to be stored as a blob. +
  +
  Parameters:
  blob - Whether this DatabaseEntry is configured to be stored as a blob.
  +
+ + + +
- +
  getBlob
  +
```
public boolean getBlob()
```
  +
  Return whether this DatabaseEntry is configured to be stored as a blob. +
  +
  Returns:
  Whether this DatabaseEntry is configured to be stored as a blob.
  +
+ + + +
- +
  getData
  +
```
public byte[] getData()
```
  +
  Return the byte array.
  For a DatabaseEntry that is used as an output parameter, the byte array will always be a newly allocated array. The byte array specified by the caller will not be used and may be null. -
  -
  -
  - -
  Returns:
  The byte array.
  -
  -

- -

-getDataNIO

-public ByteBuffer getDataNIO()

Return the java.nio.ByteBuffer. +

- -com.sleepycat.db - -Class DatabaseEntry

Class DatabaseEntry

Input and Output Parameters

Offset and Size Properties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

-DatabaseEntry

-DatabaseEntry

Constructor Detail

DatabaseEntry

DatabaseEntry

-DatabaseEntry

-DatabaseEntry

DatabaseEntry

DatabaseEntry

-getData

Method Detail

setBlob

getBlob

getData

-getDataNIO

getDataNIO

-setData

-setData

setData

setData

-setDataNIO

setDataNIO

-setDataNIO

setDataNIO

-getOffset

getOffset

-setOffset

-getPartialLength

setOffset

getPartialLength

-getPartialOffset

getPartialOffset

-getPartial

getPartial

-setPartialOffset

setPartialOffset

-setPartialLength

setPartialLength

-setPartial

setPartial

-setPartial

setPartial

-getReadOnly

-setReadOnly

-getRecordNumber

getReadOnly

setReadOnly

getRecordNumber

-setRecordNumber

setRecordNumber

-getReuseBuffer

getReuseBuffer

-setReuseBuffer

setReuseBuffer

-getSize

getSize

-setSize

-getUserBuffer

setSize

getUserBuffer

-getUserBufferLength

getUserBufferLength

-setUserBuffer

setUserBuffer

-equals

equals

-hashCode

hashCode

- -com.sleepycat.db -
-Class DatabaseEntry