SortedPackedIntegerBinding (Oracle - Berkeley DB Java API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Berkeley DB
version 5.3.28

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sleepycat.bind.tuple
Class SortedPackedIntegerBinding

java.lang.Object
  com.sleepycat.bind.tuple.TupleBase<E>
      com.sleepycat.bind.tuple.TupleBinding<Integer>
          com.sleepycat.bind.tuple.SortedPackedIntegerBinding

All Implemented Interfaces:: EntryBinding<Integer>

public class SortedPackedIntegerBinding
extends TupleBinding<Integer>
extends TupleBinding<Integer>

A concrete TupleBinding for a sorted Integer primitive wrapper or a sorted int primitive, that stores the value in the smallest number of bytes possible.

There are two ways to use this class:

When using the com.sleepycat.db package directly, the static methods in this class can be used to convert between primitive values and DatabaseEntry objects.
When using the com.sleepycat.collections package, an instance of this class can be used with any stored collection.

See Also:: Integer Formats

Constructor Summary
`SortedPackedIntegerBinding()`

Method Summary
`static int`	`entryToInt(DatabaseEntry entry)` Converts an entry buffer into a simple `int` value.
`Integer`	`entryToObject(TupleInput input)` Constructs a key or data object from a `TupleInput` entry.
`protected TupleOutput`	`getTupleOutput(Integer object)` Returns an empty TupleOutput instance that will be used by the tuple binding or key creator.
`static void`	`intToEntry(int val, DatabaseEntry entry)` Converts a simple `int` value into an entry buffer, using SortedPackedInteger format.
`void`	`objectToEntry(Integer object, TupleOutput output)` Converts a key or data object to a tuple entry.

Methods inherited from class com.sleepycat.bind.tuple.TupleBinding
`entryToObject, getPrimitiveBinding, objectToEntry`

Methods inherited from class com.sleepycat.bind.tuple.TupleBase
`entryToInput, getTupleBufferSize, inputToEntry, newOutput, newOutput, outputToEntry, setTupleBufferSize`

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

Constructor Detail

SortedPackedIntegerBinding

public SortedPackedIntegerBinding()

Method Detail

entryToObject

public Integer entryToObject(TupleInput input)

Description copied from class: TupleBinding

Constructs a key or data object from a TupleInput entry.

Specified by:: entryToObject in class TupleBinding<Integer>

Parameters:: input - is the tuple key or data entry.
Returns:: the key or data object constructed from the entry.

objectToEntry

public void objectToEntry(Integer object,
                          TupleOutput output)

Description copied from class: TupleBinding

Converts a key or data object to a tuple entry.

Specified by:: objectToEntry in class TupleBinding<Integer>

Parameters:: object - is the key or data object.; output - is the tuple entry to which the key or data should be written.

getTupleOutput

protected TupleOutput getTupleOutput(Integer object)

Description copied from class: TupleBase

Returns an empty TupleOutput instance that will be used by the tuple binding or key creator.

The default implementation of this method creates a new TupleOutput with an initial buffer size that can be changed using the TupleBase.setTupleBufferSize(int) method.

This method may be overridden to return a TupleOutput instance. For example, an instance per thread could be created and returned by this method. If a TupleOutput instance is reused, be sure to call its FastOutputStream.reset() method before each use.

Overrides:: getTupleOutput in class TupleBase<Integer>

Parameters:: object - is the object to be written to the tuple output, and may be used by subclasses to determine the size of the output buffer.
Returns:: an empty TupleOutput instance.
See Also:: TupleBase.setTupleBufferSize(int)

entryToInt

public static int entryToInt(DatabaseEntry entry)

Converts an entry buffer into a simple int value.

Parameters:: entry - is the source entry buffer.
Returns:: the resulting value.

intToEntry

public static void intToEntry(int val,
                              DatabaseEntry entry)

Converts a simple int value into an entry buffer, using SortedPackedInteger format.

Parameters:: val - is the source value.; entry - is the destination entry buffer.