MultipleEntry (Sleepycat Software, Inc. - Berkeley DB Java API)
Keywords: com.sleepycat.db.MultipleEntry class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Berkeley DB version 4.3.29
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sleepycat.db
Class MultipleEntry

    java.lang.Object
      com.sleepycat.db.DatabaseEntry
          com.sleepycat.db.MultipleEntry

Direct Known Subclasses:
  MultipleDataEntry, MultipleKeyDataEntry, MultipleRecnoDataEntry

public abstract class MultipleEntry
extends DatabaseEntry

An abstract class representing a DatabaseEntry that holds multiple results returned by a single `Cursor` get method. Use one of the concrete subclasses depending on whether you need:

- multiple data items only: `MultipleDataEntry`
- multiple key / data item pairs: `MultipleKeyDataEntry`
- multiple record number / data item pairs: `MultipleRecnoDataEntry`

Method Summary
`void` | `setUserBuffer(int length, boolean usermem)` Configures the entry with an application-owned buffer.

Methods inherited from class com.sleepycat.db.DatabaseEntry
`getData, getOffset, getPartial, getPartialLength, getPartialOffset, getRecordNumber, getReuseBuffer, getSize, getUserBuffer, getUserBufferLength, setData, setData, setOffset, setPartial, setPartial, setPartialLength, setPartialOffset, setRecordNumber, setReuseBuffer, setSize`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### setUserBuffer

    public void setUserBuffer(int length,
                              boolean usermem)

  Description copied from class: `DatabaseEntry`
  Configures the entry with an application-owned buffer.

  The `data` field of the entry must refer to a buffer that is at least `length` bytes in length.

  If the length of the requested item is less than or equal to that number of bytes, the item is copied into the memory to which the `data` field refers. Otherwise, the `size` field is set to the length needed for the requested item, and a `MemoryException` is thrown.

  Applications can determine the length of a record by setting `length` to 0 and calling `DatabaseEntry.getSize` on the return value.

  Overrides:
    `setUserBuffer` in class `DatabaseEntry`
  Parameters:
    `length` - the length of the buffer

    `usermem` - whether the buffer is owned by the application

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Berkeley DB version 4.3.29
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 1996-2004 Sleepycat Software, Inc. - All rights reserved.