StringBinding (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 StringBinding

java.lang.Object
  com.sleepycat.bind.tuple.TupleBase<E>
      com.sleepycat.bind.tuple.TupleBinding<String>
          com.sleepycat.bind.tuple.StringBinding

All Implemented Interfaces:: EntryBinding<String>

public class StringBinding
extends TupleBinding<String>
extends TupleBinding<String>

A concrete TupleBinding for a simple String value.

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. The easiest way to obtain a binding instance is with the TupleBinding.getPrimitiveBinding(java.lang.Class) method.

See Also:: String Formats

Constructor Summary
`StringBinding()`

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

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

StringBinding

public StringBinding()

Method Detail

entryToObject

public String entryToObject(TupleInput input)

Description copied from class: TupleBinding

Constructs a key or data object from a TupleInput entry.

Specified by:: entryToObject in class TupleBinding<String>

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

objectToEntry

public void objectToEntry(String object,
                          TupleOutput output)

Description copied from class: TupleBinding

Converts a key or data object to a tuple entry.

Specified by:: objectToEntry in class TupleBinding<String>

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(String 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<String>

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)

entryToString

public static String entryToString(DatabaseEntry entry)

Converts an entry buffer into a simple String value.

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

stringToEntry

public static void stringToEntry(String val,
                                 DatabaseEntry entry)

Converts a simple String value into an entry buffer.

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