Value (org.openidentityplatform.commons.parent 2.2.3 Documentation)

java.lang.Object
- com.persistit.Value

```
public final class Value
extends Object
```
Encapsulates the serialized form of an Object or a primitive value. To store data, the application modifies the Exchange's Value object and then invokes the Exchange.store() operation to write the encoded value into the database. To fetch data, the application modifies the Exchange's Key object, invokes the Exchange.fetch() operation and then reads the resulting state from the Value.

A Value's state is represented internally by an array of bytes. Methods of this class encode primitive or object values into the byte array, and decode bytes in the array into values equivalent to their original values. For primitive-valued values, the decoded value is identical to the original value. That is, after:
```
 int a = 123;
 value.put(a);
 int b = value.get();
 
```
a == b is true. For object-valued items, the result will be an object that, subject to the accuracy of serialization code, is equal to the original object, but generally with different identity. That is, after:
```
 Object a = new Fricostat();
 value.put(a);
 int b = value.get();
 
```
usually a == b is false, but a.equals(b) is true.

Value uses three strategies for these conversions:
- For primitive types, their wrapper classes and certain other classes, Value uses built-in logic to perform these conversions. Objects of class java.lang.String, java.util.Date, java.math.BigInteger, java.math.BigDecimal and all arrays are encoded and decoded by built-in methods.
- For an object of any other class, the encoding and decoding methods of Value attempt to find an associated ValueCoder to perform custom encoding and decoding of the object.
- If there is no ValueCoder then if the class implements java.io.Serializable or java.io.Externalizable, encoding and decoding is performed through serialization logic using extended java.io.ObjectOutputStream and java.io.ObjectInputStream classes implemented by Value.
Note that Value can only encode an object if it has a ValueCoder or implements either java.io.Serializable or java.io.Externalizable.

Persistit JSA 1.1 introduces a faster, more compact internal storage format for serialization. Objects encoded in 1.1 without the assistance of a registered ValueCoder are normally stored in this new format and cannot be decoded by earlier versions of Persistit. However, the converse is not true: objects serialized by earlier versions of Persistit can be deserialized properly by 1.1. Thus you may upgrade an installed application from version 1.0 to 1.1 without running any type of database conversion process.

In certain cases it may be preferable to store values using the default Java serialization format defined by the Java Object Serialization Specification. You may set the serialOverride configuration property to specify classes that are to be serialized in standard form.

See Persistit JSA 1.1 Object Serialization for more detailed information on these these subjects.

Value as the key of a HashMap or WeakHashMap

It may be useful to build a WeakHashMap associating the serialized content of a Value with an associated deserialized object to avoid object deserialization overhead or to implement correct identity semantics. Since Value is mutable it is a poor choice for use as a map key. Instead, an immutable ValueState should be used to hold an immutable copy of this state. Value and ValueState implement hashCode and equals in a compatible fashion so that code similar to the following works as expected:
```
      ...
      Value value = <some value>;
      if (!map.contains(value))   // uses the transient current state
      {
          ValueState vs = new ValueState(value);
          map.put(vs, object);    // uses an immutable copy as the key
      }
 
```
Displayable Format

The toString() method of this class attempts to construct a human-readable representation of the serialized value. The Tree display panel of the AdminUI utility uses this capability to summarize the contents of values stored in a tree. The string representation is constructed as follows:
1. If the state represented by this Value is undefined, then return "undefined".
2. If the state is null or a boolean, return "null" "false", or "true".
3. If the value represents a primitive type, return the string representation of the value, prefixed by "(byte)", "(short)", "(char)", "(long)", or "(float)" for the corresponding types. Values of type int and double are presented without prefix to reduce clutter.
4. If the value represents a String, return a modified form of the string enclosed in double quotes. For each character of the string, if it is a double quote replace it by "\"", otherwise if it is outside of the printable ASCII character set replace the character in the modified string by "\b", "\t", "\n", "\r" or "" such that the modified string would be a valid Java string constant.
5. If the value represents a java.util.Date, return a formatted representation of the date using the format specified by Key.SDF. This is a readable format the displays the date with full precision, including milliseconds.
6. If the value represents an array, return a list of comma-separated element values surrounded by square brackets.
7. If the value represents one of the standard Collection implementations in the java.util package, then return a comma-separated list of values surrounded by square brackets.
8. If the value represents one of the standard Map implementations in the java.util package, then return a comma-separated list of key/value pairs surrounded by square brackets. Each key/value pair is represented by a string in the form key->value.
9. If the value represents an object of a class for which there is a registered ValueDisplayer, invoke the displayer's display method to format a displayable representation of the object.
10. If the value represents an object that has been stored using the version 1.1 storage mechanism described object, return the class name of the object followed by a comma-separated tuple, enclosed within curly brace characters, representing the value of each field of the object.
11. If the value represents an object encoded through standard Java serialization, return the string "(Serialized-object)" followed by a sequence of hex digits representing the serialized bytes. Note that this process does not attempt to deserialize the object, which might have unintended consequences.
12. If the value represents an object that has already been represented within the formatted result - for example, if a Collection contain two references to the same object - then instead of creating an additional string representing the second or subsequent instance, emit a back reference pointer in the form @NNN where NNN is the character offset within the displayable string where the first instance was found. (Note: does not apply to strings and the primitive wrapper classes.)
For example, consider a Person class with fields for date of birth, first name, last name, salary and friends, an array of other Person objects. The result returned by toString() on a Value representing two Person instances, each with just the other as a friend, might appear as follows: (Note, space added for legibility.)
```
 
 (Person){(Date)19490826000000.000-0400,"Mary","Jones",(long)75000,[
    (Person){(Date)19550522000000.000-0400,"John","Smith",(long)68000,[@0]}]}
 
 
```
In this example, John Smith's friends array contains a back reference to Mary Jones in the form "@0" because Mary's displayable reference starts at the beginning of the string.

Stream mode

A Value normally contains just one object or primitive value. In its normal mode of operation, the put operation overwrites any previously held state, and the get operation retrieves the one object or primitive value represented by the current state of the Value. A subsequent invocation of get returns the same value.

However, at certain times it is useful to store multiple items (fields) together in one Value object. To allow this, Value implements an alternative mode of operation called stream mode in which each put invocation appends a new field to the state rather than replacing the previous state. Similarly, get operations retrieve sequentially written fields rather than rereading the same field. Stream allows ValueCoder implementations to aggregate the multiple fields encapsulated within an encoded value.

Low-Level API

The low-level API allows an application to bypass the encoding and decoding operations described above and instead to operate directly on the byte array stored in the database. This might be appropriate for an existing application that has already implemented its own serialization mechanisms. Applications should use these methods only if there is a compelling design requirement to do so.

The low-level API methods are:
```
      byte[] getEncodedBytes()
      int getEncodedSize()
      void setEncodedSize(int)
      void putEncodedBytes(byte[], int, int)
      void copyFromEncodedBytes(byte[], int, int, int)
      boolean ensureFit(int)
 
```
Version:

1.1

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Value.OldValueInputStream
An ObjectOutputStream that reads bytes from this Value using standard Java serialization.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Value.OldValueInputStream` An ObjectOutputStream that reads bytes from this Value using standard Java serialization.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAXIMUM_SIZE` Default maximum size to which the backing buffer can grow.
`static Value`	`EMPTY_VALUE` A Value that is always EMPTY - i.e., for which `isDefined()` is always false.
`static int`	`INITIAL_SIZE` Default initial size of the byte array that backs this `Value` .
`static int`	`MAXIMUM_SIZE` Absolute maximum size limit.

Constructor Summary

Constructors
Constructor and Description
`Value(Persistit persistit)` Construct a `Value` object with default initial and maximum encoded sizes.
`Value(Persistit persistit, int initialSize)` Construct a `Value` object with specified initial encoded size and default maximum size.
`Value(Persistit persistit, int initialSize, int maximumSize)` Construct a `Value` object with specific initial encoded size and specified maximum size.
`Value(Value source)` Construct a new `Value` that represents the same data as the source.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Value`	`clear()` Remove all content from this `Value`.
`void`	`copyFromEncodedBytes(byte[] dest, int from, int to, int length)` Copy a subarray from the encoded byte array to a target.
`void`	`copyTo(Value target)` Copy the state of this `Value` to another `Value`.
`void`	`decodeDisplayable(boolean quoted, StringBuilder sb)` Appends a displayable, printable String version of a value into the supplied StringBuilder.
`void`	`decodeDisplayable(boolean quoted, StringBuilder sb, CoderContext context)` Appends a displayable String version of a value into the supplied StringBuilder.
`Object`	`directGet(ValueRenderer coder, Class<?> clazz, CoderContext context)` Optimized get method to be used in specialized circumstances where an applications can supply a `ValueCoder` directly.
`Object`	`directGet(ValueRenderer coder, Object target, Class<?> clazz, CoderContext context)` Optimized get method to be used in specialized circumstances where an applications can supply a `ValueCoder` directly.
`void`	`directPut(ValueCoder coder, Object object, CoderContext context)` Optimized put method to be used in specialized circumstances where an applications can supply a `ValueCoder` directly.
`boolean`	`ensureFit(int length)` Ensures that the specified number of bytes can be appended to the backing byte array.
`boolean`	`equals(Object obj)` Implements the `equals` method such that `Value` and `ValueState` objects may be used interchangeably as map keys.
`Object`	`get()` Decodes the object value represented by the current state of this `Value`.
`Object`	`get(Object target)` Decodes the object value represented by the current state of this `Value`.
`Object`	`get(Object target, CoderContext context)` Decodes the object value represented by the current state of this `Value`.
`Object`	`getArray()` Decodes the array value represented by the current state of this `Value`.
`int`	`getArrayLength()` Returns the element count for the array represented by the current state of this `Value`.
`BigDecimal`	`getBigDecimal()` Decodes the `java.math.BigDecimal` value represented by the current state of this `Value`.
`BigInteger`	`getBigInteger()` Decodes the `java.math.BigInteger` value represented by the current state of this `Value`.
`boolean`	`getBoolean()` Decodes the boolean value represented by the current state of this `Value`.
`boolean[]`	`getBooleanArray()` Returns a `boolean` array representing the state of this `Value`.
`int`	`getBooleanArray(boolean[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `boolean` array represented by the state of this `Value` into the supplied target array.
`byte`	`getByte()` Decodes the byte value represented by the current state of this `Value`.
`byte[]`	`getByteArray()` Returns a `byte` array representing the state of this `Value`.
`int`	`getByteArray(byte[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `byte` array represented by the state of this `Value` into the supplied target array.
`char`	`getChar()` Decodes the char value represented by the current state of this `Value`.
`char[]`	`getCharArray()` Returns a `char` array representing the state of this `Value`.
`int`	`getCharArray(char[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `char` array represented by the state of this `Value` into the supplied target array.
`int`	`getCursor()`
`Date`	`getDate()` Decodes the `java.util.Date` value represented by the current state of this `Value`.
`double`	`getDouble()` Decodes the double value represented by the current state of this `Value`.
`double[]`	`getDoubleArray()` Returns a `double` array representing the state of this `Value`.
`int`	`getDoubleArray(double[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `double` array represented by the state of this `Value` into the supplied target array.
`byte[]`	`getEncodedBytes()` Returns the backing byte array used to hold the state of this `Value`.
`int`	`getEncodedSize()` Returns the number of bytes used to encode the current value.
`float`	`getFloat()` Decodes the float value represented by the current state of this `Value`.
`float[]`	`getFloatArray()` Returns a `float` array representing the state of this `Value`.
`int`	`getFloatArray(float[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `float` array represented by the state of this `Value` into the supplied target array.
`int`	`getInt()` Decodes the int value represented by the current state of this `Value`.
`int[]`	`getIntArray()` Returns a `int` array representing the state of this `Value`.
`int`	`getIntArray(int[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `int` array represented by the state of this `Value` into the supplied target array.
`long`	`getLong()` Decodes the long value represented by the current state of this `Value`.
`long[]`	`getLongArray()` Returns a `long` array representing the state of this `Value`.
`int`	`getLongArray(long[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `long` array represented by the state of this `Value` into the supplied target array.
`int`	`getMaximumSize()` Returns the maximum size to which the backing buffer can grow.
`Object`	`getNull()` Decodes the object value represented by the current state of this `Value` and verifies that it is `null`.
`Object[]`	`getObjectArray()` Returns a `Object` array representing the state of this `Value`.
`ObjectInputStream`	`getObjectInputStream()` Return a `java.io.ObjectInputStream` that reads bytes from this Value.
`ObjectOutputStream`	`getObjectOutputStream()` Return a `java.io.ObjectOutputStream` that writes bytes directly into this Value.
`short`	`getShort()` Decodes the short value represented by the current state of this `Value`.
`short[]`	`getShortArray()` Returns a `short` array representing the state of this `Value`.
`int`	`getShortArray(short[] array, int fromOffset, int toOffset, int length)` Copies a subarray of the `short` array represented by the state of this `Value` into the supplied target array.
`String`	`getString()` Decodes the `java.lang.String` value represented by the current state of this `Value`.
`<T extends Appendable> Appendable`	`getString(T sb)` Decodes the `java.lang.String` value represented by the current state of this `Value` into a supplied `java.lang.Appendable`.
`String[]`	`getStringArray()` Returns a `Object` array representing the state of this `Value`.
`Class<?>`	`getType()` Returns the type of the object represented by the current state of this `Value`.
`int`	`hashCode()` Hash code for the current state of this `Value`.
`boolean`	`hasMoreItems()` Indicates whether there is at least one more item in this `Value`.
`boolean`	`isDefined()` Indicates whether there is data associated with this `Value`.
`boolean`	`isNull()` Tests whether the data held by this `Value` is null.
`boolean`	`isNull(boolean skipNull)` Determine whether the data held by this `Value` is null.
`boolean`	`isStreamMode()` Indicates whether stream mode is enabled.
`boolean`	`isType(Class<?> clazz)`
`Value.OldValueInputStream`	`oldValueInputStream(ObjectStreamClass classDescriptor)`
`com.persistit.Value.OldValueOutputStream`	`oldValueOutputStream(ObjectStreamClass classDescriptor)`
`Object`	`peek()` Decodes the object value represented by the current state of this `Value`.
`Object`	`peek(Object target)` Decodes the object value represented by the current state of this `Value`.
`Object`	`peek(Object target, CoderContext context)` Decodes the object value represented by the current state of this `Value`.
`void`	`put(boolean booleanValue)` Replaces the current state with the supplied `boolean` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(byte byteValue)` Replaces the current state with the supplied `byte` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(char charValue)` Replaces the current state with the supplied `char` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(double doubleValue)` Replaces the current state with the supplied `double` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(float floatValue)` Replaces the current state with the supplied `float` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(int intValue)` Replaces the current state with the supplied `int` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(long longValue)` Replaces the current state with the supplied `long` value (or in stream mode, appends a new field containing this value to the state).
`void`	`put(Object object)` Replaces the current state with the supplied `Object` (or in stream mode, appends a new field containing this value to the state).
`void`	`put(Object object, CoderContext context)` Replaces the current state with the supplied `Object` (or in stream mode, appends a new field containing this value to the state).
`void`	`put(short shortValue)` Replaces the current state with the supplied `short` value (or in stream mode, appends a new field containing this value to the state).
`void`	`putBigDecimal(BigDecimal bigDecimalValue)` Replaces the current state with the supplied `java.math.BigDecimal` (or in stream mode, appends a new field containing this value to the state).
`void`	`putBigInteger(BigInteger bigIntValue)` Replaces the current state with the supplied `java.math.BigInteger` (or in stream mode, appends a new field containing this value to the state).
`void`	`putBooleanArray(boolean[] array)` Replaces the current state with the supplied `boolean` (or in stream mode, appends a new field containing this array to the state).
`void`	`putBooleanArray(boolean[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `boolean`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putByteArray(byte[] array)` Replaces the current state with the supplied `byte` array, (or in stream mode, appends a new field containing this array to the state).
`void`	`putByteArray(byte[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `byte`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putCharArray(char[] array)` Replaces the current state with the supplied `char` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putCharArray(char[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `char`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putDate(Date dateValue)` Replaces the current state with the supplied `java.util.Date` (or in stream mode, appends a new field containing this value to the state).
`void`	`putDoubleArray(double[] array)` Replaces the current state with the supplied `double` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putDoubleArray(double[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `double`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putEncodedBytes(byte[] from, int offset, int length)` Replace the encoded value with bytes from a supplied array.
`void`	`putFloatArray(float[] array)` Replaces the current state with the supplied `float` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putFloatArray(float[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `float`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putIntArray(int[] array)` Replaces the current state with the supplied `int` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putIntArray(int[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `int`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putLongArray(long[] array)` Replaces the current state with the supplied `long` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putLongArray(long[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `long`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putNull()` Replaces the current state with null (or in stream mode, appends a null to the state).
`void`	`putObjectArray(Object[] array)` Replaces the current state with the supplied `Object` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putObjectArray(Object[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `Object`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putShortArray(short[] array)` Replaces the current state with the supplied `short` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putShortArray(short[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `short`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putString(CharSequence sb)` Replaces the current state with the String represented by the supplied CharSequence (or in stream mode, appends a new field containing this value to the state).
`void`	`putString(String string)` Replaces the current state with the supplied `java.lang.String` (or in stream mode, appends a new field containing this value to the state).
`void`	`putStringArray(String[] array)` Replaces the current state with the supplied `String` array (or in stream mode, appends a new field containing this array to the state).
`void`	`putStringArray(String[] array, int offset, int length)` Replaces the current state with a subarray of the supplied array of `String`-valued elements (or in stream mode, appends a new field containing this subarray to the state).
`void`	`putUTF(String string)` Replaces the current state with the supplied `java.lang.String` (or in stream mode, appends a new field containing this value to the state).
`void`	`registerEncodedObject(Object object)` Registers an object with an internal handle used to represent back references.
`void`	`setCursor(int cursor)`
`void`	`setEncodedSize(int size)` Sets the length of the encoded data in the backing byte array.
`void`	`setMaximumSize(int size)` Deprecated. use `Exchange.setMaximumValueSize(int)`. This method should not be public.
`void`	`setStreamMode(boolean b)` Enables or disables stream mode.
`void`	`skip()` Does nothing except when this `Value` is in stream mode.
`String`	`toString()` Provides a String representation of the state of this `Value`.
`boolean`	`trim()` Reduce the backing byte buffer to the minimal length needed to represent the current state.
`boolean`	`trim(int newSize)` Reduce the backing byte buffer to the greater of the minimal length needed to represent the current state and the specified lower bound.

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

- Field Detail
  - EMPTY_VALUE
```
public static final Value EMPTY_VALUE
```
    A Value that is always EMPTY - i.e., for which isDefined() is always false.
  - INITIAL_SIZE
```
public static final int INITIAL_SIZE
```
    Default initial size of the byte array that backs this Value .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXIMUM_SIZE
```
public static final int DEFAULT_MAXIMUM_SIZE
```
    Default maximum size to which the backing buffer can grow. The default value is 4Mb.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_SIZE
```
public static final int MAXIMUM_SIZE
```
    Absolute maximum size limit.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Value
```
public Value(Persistit persistit)
```
    Construct a Value object with default initial and maximum encoded sizes.
  - Value
```
public Value(Persistit persistit,
             int initialSize)
```
    Construct a Value object with specified initial encoded size and default maximum size.
    
    Parameters:
    
    initialSize - Initial size of the encoded value buffer.
  - Value
```
public Value(Persistit persistit,
             int initialSize,
             int maximumSize)
```
    Construct a Value object with specific initial encoded size and specified maximum size.
    
    Parameters:
    
    initialSize - Initial size of the encoded value buffer.
    
    maximumSize - Maximum size of the encoded value buffer.
  - Value
```
public Value(Value source)
```
    Construct a new Value that represents the same data as the source.
    
    Parameters:
    
    source - A Value whose state should be copied as the initial state of this Value.
- Method Detail
  - clear
```
public Value clear()
```
    Remove all content from this Value. This method also disables stream mode.
    
    Returns:
    
    this Value to permit call-chaining
  - copyTo
```
public void copyTo(Value target)
```
    Copy the state of this Value to another Value.
    
    Parameters:
    
    target - The Value to which state should be copied.
  - hashCode
```
public int hashCode()
```
    Hash code for the current state of this Value. Note that if the underlying state changes, hashCode will produce a different result. Construct a ValueState instance to hold an immutable copy of the current state of a Value.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Implements the equals method such that Value and ValueState objects may be used interchangeably as map keys.
    
    Overrides:
    
    equals in class Object
  - trim
```
public boolean trim()
```
    Reduce the backing byte buffer to the minimal length needed to represent the current state.
    
    Returns:
    
    true if the size was actually reduced.
  - trim
```
public boolean trim(int newSize)
```
    Reduce the backing byte buffer to the greater of the minimal length needed to represent the current state and the specified lower bound.
    
    Parameters:
    
    newSize - the minimum size of the backing buffer.
    
    Returns:
    
    true if the size was actually reduced.
  - ensureFit
```
public boolean ensureFit(int length)
```
    Ensures that the specified number of bytes can be appended to the backing byte array. If the available space is too small, this method replaces the array with a new one having at least length available bytes. Applications using the low-level API must call getEncodedBytes() to get a reference to the new array after this replacement has occurred.
    
    This method is part of the Low-Level API.
    
    Parameters:
    
    length -
    
    Returns:
    
    true if the backing byte array was replaced by a larger array.
  - copyFromEncodedBytes
```
public void copyFromEncodedBytes(byte[] dest,
                                 int from,
                                 int to,
                                 int length)
```
    Copy a subarray from the encoded byte array to a target. This method is part of the Low-Level API.
    
    Parameters:
    
    dest - The target byte array
    
    from - Offset from which to start the copy
    
    to - Offset into the target at which the subarray should be copied
    
    length - Number of bytes to copy
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - getEncodedSize
```
public int getEncodedSize()
```
    Returns the number of bytes used to encode the current value. This method is part of the Low-Level API.
    
    Returns:
    
    The size
  - putEncodedBytes
```
public void putEncodedBytes(byte[] from,
                            int offset,
                            int length)
```
    Replace the encoded value with bytes from a supplied array. This method is part of the Low-Level API.
    
    Parameters:
    
    from - Byte array from which to copy the encoded value
    
    offset - Offset to first byte in the supplied array from which to copy
    
    length - Number of bytes to copy
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the supplied offset or size exceed the bounds of the supplied array
    
    ConversionException - if the resulting value size exceeds the maximum size
  - getEncodedBytes
```
public byte[] getEncodedBytes()
```
    Returns the backing byte array used to hold the state of this Value. This method is part of the Low-Level API.
    
    Returns:
    
    The byte array
  - setEncodedSize
```
public void setEncodedSize(int size)
```
    Sets the length of the encoded data in the backing byte array. This length governs the number of bytes from the backing byte array that will be stored in the database during the next store operation. This method is part of the Low-Level API.
  - getMaximumSize
```
public int getMaximumSize()
```
    Returns the maximum size to which the backing buffer can grow.
    
    Returns:
    
    The maximum size
  - setMaximumSize
```
@Deprecated
public void setMaximumSize(int size)
```
    Deprecated. use Exchange.setMaximumValueSize(int). This method should not be public.
    
    Modifies the maximum size to which the backing buffer can grow and trims the current backing buffer to be no larger than the new maximum.
    
    Parameters:
    
    size - The maximum size
    
    Throws:
    
    IllegalArgumentException - If the backing buffer is already larger than size, this method
  - getCursor
```
public int getCursor()
```
  - setCursor
```
public void setCursor(int cursor)
```
  - setStreamMode
```
public void setStreamMode(boolean b)
```
    Enables or disables stream mode. See Stream Mode for further information.
    
    Parameters:
    
    b - true to enable stream mode, false to disable it.
  - isStreamMode
```
public boolean isStreamMode()
```
    Indicates whether stream mode is enabled. See Stream Mode for further information.
    
    Returns:
    
    true if stream mode is enabled.
  - isDefined
```
public boolean isDefined()
```
    Indicates whether there is data associated with this Value. The result of fetching a Key that has no associated record in the database leaves the corresponding Value in an undefined state. Note that a Value containing null is defined. Persistit distinguishes between null and undefined states.
    
    Returns:
    
    true if there is data represented by this Value .
  - isNull
```
public boolean isNull()
```
    Tests whether the data held by this Value is null.
    
    Returns:
    
    true if the current state of this Value represents null.
  - isNull
```
public boolean isNull(boolean skipNull)
```
    Determine whether the data held by this Value is null. As a side effect, if skipNull is true and Stream Mode is enabled this method also advances the cursor to the next field if the current field is null.
    
    Parameters:
    
    skipNull - if true, the Value is in stream mode and the current field is null, then advance the cursor to next field
    
    Returns:
    
    true if the current state of this Value represents null.
  - toString
```
public String toString()
```
    Provides a String representation of the state of this Value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A String value. If this Value is undefined, returns the word "undefined". Note that this value is indistinguishable from the result of toString on a Value whose state represents the string "undefined". Invoke the isDefined() method to determine reliably whether the Value is defined.
    
    See Also:
    
    decodeDisplayable(boolean, StringBuilder)
  - decodeDisplayable
```
public void decodeDisplayable(boolean quoted,
                              StringBuilder sb)
```
    Appends a displayable, printable String version of a value into the supplied StringBuilder. If quoted is true, then the all String values in the result will be enclosed and converted to a printable format.
    
    Parameters:
    
    quoted - true to quote and convert all strings to printable form.
    
    sb - A StringBuilder to which the displayable value will be appended.
    
    See Also:
    
    decodeDisplayable(boolean, StringBuilder, CoderContext)
  - decodeDisplayable
```
public void decodeDisplayable(boolean quoted,
                              StringBuilder sb,
                              CoderContext context)
```
    Appends a displayable String version of a value into the supplied StringBuilder. If quoted is true, then the all String values in the result will be enclosed and converted to a printable format.
    
    Parameters:
    
    quoted - true to quote and convert all strings to printable form.
    
    sb - A StringBuilder to which the displayable value will be appended.
    
    context - A CoderContext to be passed to any underlying ValueDisplayer.
  - getType
```
public Class<?> getType()
```
    Returns the type of the object represented by the current state of this Value.
    
    Returns:
    
    The type
  - isType
```
public boolean isType(Class<?> clazz)
```
  - getNull
```
public Object getNull()
```
    Decodes the object value represented by the current state of this Value and verifies that it is null.
    
    Returns:
    
    null
    
    Throws:
    
    ConversionException - if this Value does not currently represent null.
  - getBoolean
```
public boolean getBoolean()
```
    Decodes the boolean value represented by the current state of this Value.
    
    Returns:
    
    The value as a boolean.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getByte
```
public byte getByte()
```
    Decodes the byte value represented by the current state of this Value.
    
    Returns:
    
    The value as a byte.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getShort
```
public short getShort()
```
    Decodes the short value represented by the current state of this Value.
    
    Returns:
    
    The value as a short.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getChar
```
public char getChar()
```
    Decodes the char value represented by the current state of this Value.
    
    Returns:
    
    The value as a char.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getInt
```
public int getInt()
```
    Decodes the int value represented by the current state of this Value.
    
    Returns:
    
    The value as a int.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getLong
```
public long getLong()
```
    Decodes the long value represented by the current state of this Value.
    
    Returns:
    
    The value as a long.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getFloat
```
public float getFloat()
```
    Decodes the float value represented by the current state of this Value.
    
    Returns:
    
    The value as a float.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - getDouble
```
public double getDouble()
```
    Decodes the double value represented by the current state of this Value.
    
    Returns:
    
    The value as a double.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of this type.
  - peek
```
public Object peek()
```
    Decodes the object value represented by the current state of this Value. This method is identical to get() except that in Stream Mode the pointer to the next retrieved value is not advanced.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - peek
```
public Object peek(Object target)
```
    Decodes the object value represented by the current state of this Value. This method is identical to get(Object) except that in Stream Mode the pointer to the next retrieved value is not advanced.
    
    This variant of get may modify and return the target object supplied as a parameter, rather than creating a new object. This behavior will occur only if the encoded value has a registered ValueRenderer. See the documentation for ValueRenderer for more information.
    
    Parameters:
    
    target - A mutable object into which a ValueRenderer may decode this Value.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - peek
```
public Object peek(Object target,
                   CoderContext context)
```
    Decodes the object value represented by the current state of this Value. This method is identical to get(Object, CoderContext) except that in Stream Mode the pointer to the next retrieved value is not advanced.
    
    Parameters:
    
    target - A mutable object into which a ValueRenderer may decode this Value.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - get
```
public Object get()
```
    Decodes the object value represented by the current state of this Value. If the represented value is primitive, this method returns the wrapped object of the corresponding class. For example, if the value represents an int, this method returns a java.lang.Integer.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - get
```
public Object get(Object target)
```
    Decodes the object value represented by the current state of this Value. If the represented value is primitive, this method returns the wrapped object of the corresponding class. For example, if the value represents an int, this method returns a java.lang.Integer.
    
    This variant of get may modify and return the target object supplied as a parameter, rather than creating a new object. This behavior will occur only if the encoded value has a registered ValueRenderer. See the documentation for ValueRenderer for more information.
    
    Parameters:
    
    target - A mutable object into which a ValueRenderer may decode this Value.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - get
```
public Object get(Object target,
                  CoderContext context)
```
    Decodes the object value represented by the current state of this Value. If the represented value is primitive, this method returns the wrapped object of the corresponding class. For example, if the value represents an int, this method returns a java.lang.Integer.
    
    This variant of get may modify and return the target object supplied as a parameter, rather than creating a new object. This behavior will occur only if the encoded value has an associated ValueRenderer registered by CoderManager. See the documentation for those classes for a detailed explanation of value rendering.
    
    Parameters:
    
    target - A mutable object into which a ValueRenderer may decode this Value.
    
    context - An application-specified value that may assist a ValueCoder. The context is passed to the ValueCoder.get(com.persistit.Value, java.lang.Class<?>, com.persistit.encoding.CoderContext) method.
    
    Returns:
    
    The value as a Object.
    
    Throws:
    
    ConversionException - if this Value does not currently represent data of a recognizable class.
    
    MalformedValueException - if this Value is structurally corrupt.
  - registerEncodedObject
```
public void registerEncodedObject(Object object)
```
    Registers an object with an internal handle used to represent back references. For example, suppose objects x and y have fields that refer to each other. Then serializing x will serialize y, and the the reference in y to x will be represented in the serialization stream by a back reference handle. This method should be called from the ValueCoder.get(Value, Class, CoderContext) method of custom ValueCoders. See Parameters:
    object - A newly created objected whose fields are about to be deserialized
  - getString
```
public String getString()
```
    Decodes the java.lang.String value represented by the current state of this Value.
    
    Returns:
    
    The value as a String.
    
    Throws:
    
    ConversionException - if this Value does not currently represent a String.
  - getString
```
public <T extends Appendable> Appendable getString(T sb)
```
    Decodes the java.lang.String value represented by the current state of this Value into a supplied java.lang.Appendable.
    
    Returns:
    
    The supplied Appendable, modified to contain the decoded String
    
    Throws:
    
    ConversionException - if this Value does not currently represent a String.
  - getDate
```
public Date getDate()
```
    Decodes the java.util.Date value represented by the current state of this Value.
    
    Returns:
    
    The value as a Date.
    
    Throws:
    
    ConversionException - if this Value does not currently represent a Date.
  - getBigInteger
```
public BigInteger getBigInteger()
```
    Decodes the java.math.BigInteger value represented by the current state of this Value.
    
    Returns:
    
    The value as a BigInteger.
    
    Throws:
    
    ConversionException - if this Value does not currently represent a BigInteger.
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
    Decodes the java.math.BigDecimal value represented by the current state of this Value.
    
    Returns:
    
    The value as a BigDecimal.
    
    Throws:
    
    ConversionException - if this Value does not currently represent a BigDecimal.
  - getArrayLength
```
public int getArrayLength()
```
    Returns the element count for the array represented by the current state of this Value.
    
    Returns:
    
    The element count, or -1 if the Value represents null rather than an array.
    
    Throws:
    
    ConversionException - if this Value does not currently represent an array.
  - getArray
```
public Object getArray()
```
    Decodes the array value represented by the current state of this Value.
    
    Returns:
    
    The value as an Object that can be cast to an array.
    
    Throws:
    
    ConversionException - if this Value does not currently represent an array.
  - getBooleanArray
```
public boolean[] getBooleanArray()
```
    Returns a boolean array representing the state of this Value. Equivalent to (boolean)[])get().
    
    Returns:
    
    The array.
  - getBooleanArray
```
public int getBooleanArray(boolean[] array,
                           int fromOffset,
                           int toOffset,
                           int length)
```
    Copies a subarray of the boolean array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getByteArray
```
public byte[] getByteArray()
```
    Returns a byte array representing the state of this Value. Equivalent to (byte[])get().
    
    Returns:
    
    The array.
  - getByteArray
```
public int getByteArray(byte[] array,
                        int fromOffset,
                        int toOffset,
                        int length)
```
    Copies a subarray of the byte array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getShortArray
```
public short[] getShortArray()
```
    Returns a short array representing the state of this Value. Equivalent to (short[])get().
    
    Returns:
    
    The array.
  - getShortArray
```
public int getShortArray(short[] array,
                         int fromOffset,
                         int toOffset,
                         int length)
```
    Copies a subarray of the short array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getCharArray
```
public char[] getCharArray()
```
    Returns a char array representing the state of this Value. Equivalent to (char[])get().
    
    Returns:
    
    The array.
  - getCharArray
```
public int getCharArray(char[] array,
                        int fromOffset,
                        int toOffset,
                        int length)
```
    Copies a subarray of the char array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getIntArray
```
public int[] getIntArray()
```
    Returns a int array representing the state of this Value. Equivalent to (int[])get().
    
    Returns:
    
    The array.
  - getIntArray
```
public int getIntArray(int[] array,
                       int fromOffset,
                       int toOffset,
                       int length)
```
    Copies a subarray of the int array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getLongArray
```
public long[] getLongArray()
```
    Returns a long array representing the state of this Value. Equivalent to (long[])get().
    
    Returns:
    
    The array.
  - getLongArray
```
public int getLongArray(long[] array,
                        int fromOffset,
                        int toOffset,
                        int length)
```
    Copies a subarray of the long array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getFloatArray
```
public float[] getFloatArray()
```
    Returns a float array representing the state of this Value. Equivalent to (float[])get().
    
    Returns:
    
    The array.
  - getFloatArray
```
public int getFloatArray(float[] array,
                         int fromOffset,
                         int toOffset,
                         int length)
```
    Copies a subarray of the float array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getDoubleArray
```
public double[] getDoubleArray()
```
    Returns a double array representing the state of this Value. Equivalent to (double[])get().
    
    Returns:
    
    The array.
  - getDoubleArray
```
public int getDoubleArray(double[] array,
                          int fromOffset,
                          int toOffset,
                          int length)
```
    Copies a subarray of the double array represented by the state of this Value into the supplied target array. The subarray is bounded by fromOffset and length, and truncated to fit within the target array.
    
    Parameters:
    
    array - The target array
    
    fromOffset - Offset of the first element within the source array to copy from
    
    toOffset - Offset of the first element within the target array to copy to
    
    length - The maximum number of elements to copy.
    
    Returns:
    
    The number of elements actually copied, or -1 if the Value object represents null.
  - getObjectArray
```
public Object[] getObjectArray()
```
    Returns a Object array representing the state of this Value. This is equivalent to (Object[])getArray().
    
    Returns:
    
    The array.
  - getStringArray
```
public String[] getStringArray()
```
    Returns a Object array representing the state of this Value. This is equivalent to (Object[])getArray().
    
    Returns:
    
    The array.
  - hasMoreItems
```
public boolean hasMoreItems()
```
    Indicates whether there is at least one more item in this Value. This method is valid only if the Value is in Stream Mode. (See isStreamMode().)
    
    Returns:
    
    true if another item can be decoded from this Value.
  - put
```
public void put(boolean booleanValue)
```
    Replaces the current state with the supplied boolean value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    booleanValue - The new value
  - put
```
public void put(byte byteValue)
```
    Replaces the current state with the supplied byte value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    byteValue - The new value
  - put
```
public void put(short shortValue)
```
    Replaces the current state with the supplied short value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    shortValue - The new value
  - put
```
public void put(char charValue)
```
    Replaces the current state with the supplied char value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    charValue - The new value
  - put
```
public void put(int intValue)
```
    Replaces the current state with the supplied int value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    intValue - The new value
  - put
```
public void put(long longValue)
```
    Replaces the current state with the supplied long value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    longValue - The new value
  - put
```
public void put(float floatValue)
```
    Replaces the current state with the supplied float value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    floatValue - The new value
  - put
```
public void put(double doubleValue)
```
    Replaces the current state with the supplied double value (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    doubleValue - The new value
  - put
```
public void put(Object object)
```
    Replaces the current state with the supplied Object (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    object - The new value. The supplied Object must be null, or it must implement java.io.Serializable or java.io.Externalizable, or it must be handled by a registered ValueCoder.
    
    Throws:
    
    ConversionException - if the Object cannot be encoded as a sequence of bytes.
  - put
```
public void put(Object object,
                CoderContext context)
```
    Replaces the current state with the supplied Object (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    object - The new value. The supplied Object must be null, or it must implement java.io.Serializable or java.io.Externalizable, or it must be handled by a registered ValueCoder.
    
    context - An application-specified value that may assist a ValueCoder. The context is passed to the ValueCoder.put(com.persistit.Value, java.lang.Object, com.persistit.encoding.CoderContext) method.
    
    Throws:
    
    ConversionException - if the Object cannot be encoded as a sequence of bytes.
  - putNull
```
public void putNull()
```
    Replaces the current state with null (or in stream mode, appends a null to the state).
  - putString
```
public void putString(String string)
```
    Replaces the current state with the supplied java.lang.String (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    string - The new value
  - putUTF
```
public void putUTF(String string)
```
    Replaces the current state with the supplied java.lang.String (or in stream mode, appends a new field containing this value to the state). Unlike putString, this method always writes a new copy of the String rather than a reference to a previously written value. Thus on deserialization, two copies of the same string written by this method will result in two unique String objects.
    
    Parameters:
    
    string - The new value
  - putString
```
public void putString(CharSequence sb)
```
    Replaces the current state with the String represented by the supplied CharSequence (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    sb - The String value as a CharSequence
  - putDate
```
public void putDate(Date dateValue)
```
    Replaces the current state with the supplied java.util.Date (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    dateValue - The new value
  - putBigInteger
```
public void putBigInteger(BigInteger bigIntValue)
```
    Replaces the current state with the supplied java.math.BigInteger (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    bigIntValue - The new value
  - putBigDecimal
```
public void putBigDecimal(BigDecimal bigDecimalValue)
```
    Replaces the current state with the supplied java.math.BigDecimal (or in stream mode, appends a new field containing this value to the state).
    
    Parameters:
    
    bigDecimalValue - The new value
  - putBooleanArray
```
public void putBooleanArray(boolean[] array)
```
    Replaces the current state with the supplied boolean (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putBooleanArray
```
public void putBooleanArray(boolean[] array,
                            int offset,
                            int length)
```
    Replaces the current state with a subarray of the supplied array of boolean-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putByteArray
```
public void putByteArray(byte[] array)
```
    Replaces the current state with the supplied byte array, (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putByteArray
```
public void putByteArray(byte[] array,
                         int offset,
                         int length)
```
    Replaces the current state with a subarray of the supplied array of byte-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putShortArray
```
public void putShortArray(short[] array)
```
    Replaces the current state with the supplied short array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putShortArray
```
public void putShortArray(short[] array,
                          int offset,
                          int length)
```
    Replaces the current state with a subarray of the supplied array of short-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putCharArray
```
public void putCharArray(char[] array)
```
    Replaces the current state with the supplied char array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putCharArray
```
public void putCharArray(char[] array,
                         int offset,
                         int length)
```
    Replaces the current state with a subarray of the supplied array of char-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putIntArray
```
public void putIntArray(int[] array)
```
    Replaces the current state with the supplied int array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putIntArray
```
public void putIntArray(int[] array,
                        int offset,
                        int length)
```
    Replaces the current state with a subarray of the supplied array of int-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putLongArray
```
public void putLongArray(long[] array)
```
    Replaces the current state with the supplied long array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putLongArray
```
public void putLongArray(long[] array,
                         int offset,
                         int length)
```
    Replaces the current state with a subarray of the supplied array of long-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putFloatArray
```
public void putFloatArray(float[] array)
```
    Replaces the current state with the supplied float array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putFloatArray
```
public void putFloatArray(float[] array,
                          int offset,
                          int length)
```
    Replaces the current state with a subarray of the supplied array of float-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putDoubleArray
```
public void putDoubleArray(double[] array)
```
    Replaces the current state with the supplied double array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putDoubleArray
```
public void putDoubleArray(double[] array,
                           int offset,
                           int length)
```
    Replaces the current state with a subarray of the supplied array of double-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putStringArray
```
public void putStringArray(String[] array)
```
    Replaces the current state with the supplied String array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putStringArray
```
public void putStringArray(String[] array,
                           int offset,
                           int length)
```
    Replaces the current state with a subarray of the supplied array of String-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - putObjectArray
```
public void putObjectArray(Object[] array)
```
    Replaces the current state with the supplied Object array (or in stream mode, appends a new field containing this array to the state).
    
    Parameters:
    
    array - The new array value
  - putObjectArray
```
public void putObjectArray(Object[] array,
                           int offset,
                           int length)
```
    Replaces the current state with a subarray of the supplied array of Object-valued elements (or in stream mode, appends a new field containing this subarray to the state).
    
    Parameters:
    
    array - The array
    
    offset - Offset of the subarray in array
    
    length - Length of the subarray
  - skip
```
public void skip()
```
    Does nothing except when this Value is in stream mode. In stream mode, this method skips a field. It is generally faster to skip a field rather than to get and discard it because the value and its interior state do not actually need to be decoded and constructed.
  - directPut
```
public void directPut(ValueCoder coder,
                      Object object,
                      CoderContext context)
```
    Optimized put method to be used in specialized circumstances where an applications can supply a ValueCoder directly. This method receives the ValueCoder to be used from the application and therefore avoids the cost of looking it up from the class of the supplied Object. For example, suppose the application has registered a ValueCoder named myCoder to handle serialization and deserialization for a class called MyClass . The following
```
 
   value.directPut(myCoder, myClassValue, context);
 
 
```
    is equivalent to but somewhat faster than
```
 
   value.put(myClassValue, context);
 
 
```
    Parameters:
    
    coder - The ValueCoder registered for the class of object
    
    object - The object value to store
    
    context - The CoderContext or null
  - directGet
```
public Object directGet(ValueRenderer coder,
                        Class<?> clazz,
                        CoderContext context)
```
    Optimized get method to be used in specialized circumstances where an applications can supply a ValueCoder directly. This method receives the ValueCoder to be used from the application and therefore avoids the cost of looking it up from the class of the supplied Object. For example, suppose the application has registered a ValueCoder named myCoder to handle serialization and deserialization for a class called MyClass . The following
```
 
   MyClass myClassValue = (MyClass)value.directGet(myCoder, context);
 
 
```
    is equivalent to but somewhat faster than
```
 
   MyClass myClassValue = (MyClass)value.get(null, context);
 
 
```
    Parameters:
    
    coder - The ValueCoder registered for the class of object
    
    clazz - The class of the object value to get
    
    context - The CoderContext or null
    
    Returns:
    
    an object of class clazz, or null
  - directGet
```
public Object directGet(ValueRenderer coder,
                        Object target,
                        Class<?> clazz,
                        CoderContext context)
```
    Optimized get method to be used in specialized circumstances where an applications can supply a ValueCoder directly. This method receives the ValueCoder to be used from the application and therefore avoids the cost of looking it up from the class of the supplied Object. For example, suppose the application has registered a ValueCoder named myCoder to handle serialization and deserialization for a class called MyClass . The following
```
 
   MyClass myClassValue = new MyClass();
   value.directGet(myCoder, myClassValue, context);
 
 
```
    is equivalent to but somewhat faster than
```
 
   MyClass myClassValue = new MyClass();
   (MyClass)value.get(myClassValue, context);
 
 
```
    Parameters:
    
    coder - The ValueCoder registered for the class of object
    
    target - A mutable object of type clazz into which a ValueRenderer may decode this Value.
    
    clazz - The class of the object value to get
    
    context - The CoderContext or null
  - getObjectOutputStream
```
public ObjectOutputStream getObjectOutputStream()
                                         throws ConversionException
```
    Return a java.io.ObjectOutputStream that writes bytes directly into this Value. The implementation returned by this method overrides the standard implementation to work correctly within the Persistit context. See Notes on Object Serialization for details.
    
    Returns:
    
    The ObjectOutputStream
    
    Throws:
    
    ConversionException
  - getObjectInputStream
```
public ObjectInputStream getObjectInputStream()
                                       throws ConversionException
```
    Return a java.io.ObjectInputStream that reads bytes from this Value. The implementation returned by this method overrides the standard implementation to work correctly within the Persistit context. See Notes on Object Serialization for details.
    
    Returns:
    
    The ObjectInputStream
    
    Throws:
    
    ConversionException
  - oldValueInputStream
```
public Value.OldValueInputStream oldValueInputStream(ObjectStreamClass classDescriptor)
                                              throws IOException
```
    Throws:
    
    IOException
  - oldValueOutputStream
```
public com.persistit.Value.OldValueOutputStream oldValueOutputStream(ObjectStreamClass classDescriptor)
                                                              throws IOException
```
    Throws:
    
    IOException

Class Value

Value as the key of a HashMap or WeakHashMap

Displayable Format

Stream mode

Low-Level API

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_VALUE

INITIAL_SIZE

DEFAULT_MAXIMUM_SIZE

MAXIMUM_SIZE

Constructor Detail

Value

Value

Value

Value

Method Detail

clear

copyTo

hashCode

equals

trim

trim

ensureFit

copyFromEncodedBytes

getEncodedSize

putEncodedBytes

getEncodedBytes

setEncodedSize

getMaximumSize

setMaximumSize

getCursor

setCursor

setStreamMode

isStreamMode

isDefined

isNull

isNull

toString

decodeDisplayable

decodeDisplayable

getType

isType

getNull

getBoolean

getByte

getShort

getChar

getInt

getLong

getFloat

getDouble

peek

peek

peek

get

get

get

registerEncodedObject

getString

getString

getDate

getBigInteger

getBigDecimal

getArrayLength

getArray

getBooleanArray

getBooleanArray

getByteArray

getByteArray

getShortArray

getShortArray

getCharArray

getCharArray

getIntArray

getIntArray