## Uses of Class
oracle.nosql.driver.values.FieldValue

- Packages that use FieldValue
  Package | Description
  --- | ---
  oracle.nosql.driver | Contains the public API for using the Oracle NoSQL Database as well as configuration and common parameter classes used in database operations.
  oracle.nosql.driver.ops | Contains the input and response classes used for Oracle NoSQL Database operations.
  oracle.nosql.driver.values | The classes in this package are used to represent and manipulate data in the Oracle NoSQL Database.

- - ### Uses of FieldValue in oracle.nosql.driver

    Methods in oracle.nosql.driver that return FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `FieldValue` | Nson.FieldValueCreator.`getCurrentValue()` | Returns the current FieldValue if available
    `FieldValue` | FieldRange.`getEnd()` | Returns the FieldValue that defines upper bound of the range, or null if no upper bound is enforced.
    `FieldValue` | FieldRange.`getStart()` | Returns the FieldValue that defines lower bound of the range, or null if no lower bound is enforced.
    `static FieldValue` | Nson.`readFieldValue​(oracle.nosql.driver.util.ByteInputStream in)` |

    Methods in oracle.nosql.driver with parameters of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `static int` | Nson.`getSerializedSize​(FieldValue value)` |
    `FieldRange` | FieldRange.`setEnd​(FieldValue value, boolean isInclusive)` | Sets the end value of the range to the specified value.
    `FieldRange` | FieldRange.`setStart​(FieldValue value, boolean isInclusive)` | Sets the start value of the range to the specified value.
    `static void` | Nson.`writeFieldValue​(oracle.nosql.driver.util.ByteOutputStream out, FieldValue value)` |

  - ### Uses of FieldValue in oracle.nosql.driver.ops

    Methods in oracle.nosql.driver.ops that return FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `FieldValue` | PutResult.`getGeneratedValue()` | Returns the value generated if the operation created a new value.
    `FieldValue` | WriteMultipleResult.OperationResult.`getGeneratedValue()` | Returns the value generated if the operation created a new value.

    Methods in oracle.nosql.driver.ops that return types with arguments of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `Map<String,​FieldValue>` | PreparedStatement.`getVariables()` | Returns the map of variables to use for a prepared query with variables.

    Methods in oracle.nosql.driver.ops with parameters of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `PreparedStatement` | PreparedStatement.`setVariable​(int pos, FieldValue value)` | Binds an external variable to a given value.
    `PreparedStatement` | PreparedStatement.`setVariable​(String name, FieldValue value)` | Binds an external variable to a given value.

  - ### Uses of FieldValue in oracle.nosql.driver.values

    Subclasses of FieldValue in oracle.nosql.driver.values
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `ArrayValue` | ArrayValue represents an array of `FieldValue` instances.
    `class` | `BinaryValue` | A `FieldValue` instance representing a binary value.
    `class` | `BooleanValue` | A `FieldValue` instance representing a boolean value.
    `class` | `DoubleValue` | A `FieldValue` instance representing a double value.
    `class` | `IntegerValue` | A `FieldValue` instance representing an integer value.
    `class` | `JsonNullValue` | A `FieldValue` instance representing an explicit JSON null value in a JSON object or array.
    `class` | `LongValue` | A `FieldValue` instance representing a long value.
    `class` | `MapValue` | MapValue represents a row in a NoSQL Database table.
    `class` | `NullValue` | A `FieldValue` instance representing a null or missing value in a fully-typed schema.
    `class` | `NumberValue` | A `FieldValue` instance representing an arbitrary-precision numeric value.
    `class` | `StringValue` | A `FieldValue` instance representing a string value.
    `class` | `TimestampValue` | A `FieldValue` instance representing a timestamp value.

    Methods in oracle.nosql.driver.values that return FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `static FieldValue` | FieldValue.`createFromJson​(InputStream jsonInput, JsonOptions options)` | Constructs a new FieldValue instance based on JSON read from the InputStream provided.
    `static FieldValue` | FieldValue.`createFromJson​(Reader jsonInput, JsonOptions options)` | Constructs a new FieldValue instance based on JSON read from the Reader provided.
    `static FieldValue` | FieldValue.`createFromJson​(String jsonInput, JsonOptions options)` | Constructs a new FieldValue instance based on the JSON string provided.
    `static FieldValue` | JsonUtils.`createValueFromJson​(InputStream jsonInput, JsonOptions options)` |
    `static FieldValue` | JsonUtils.`createValueFromJson​(Reader jsonInput, JsonOptions options)` |
    `static FieldValue` | JsonUtils.`createValueFromJson​(String jsonInput, JsonOptions options)` |
    `FieldValue` | FieldFinder.`find​(oracle.nosql.driver.util.ByteInputStream bis)` | Looks for a the current path in an NSON stream.
    `static FieldValue` | FieldFinder.`find​(oracle.nosql.driver.util.ByteInputStream bis, String path)` | Looks for a path in an NSON stream.
    `FieldValue` | FieldFinder.`find​(MapValue map)` | Looks for the current path in a MapValue.
    `static FieldValue` | FieldFinder.`find​(MapValue map, String path)` | Looks for a path in a MapValue.
    `FieldValue` | ArrayValue.`get​(int index)` | Returns the field at the specified index.
    `FieldValue` | MapValue.`get​(String name)` | Returns the field the specified name, or null if the field does not exist.
    `FieldValue` | FieldFinder.`getTargetValue()` | Returns the target value if the path was found, null otherwise
    `FieldValue` | ArrayValue.`remove​(int index)` | Removes the element at the specified position, shifting any subsequent elements to the left.
    `FieldValue` | MapValue.`remove​(String name)` | Removes the named field if it exists.
    `FieldValue` | ArrayValue.`set​(int index, boolean value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, byte[] value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, double value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, int value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, long value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, String value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, BigDecimal value)` | Replaces the element at the specified position with the new value.
    `FieldValue` | ArrayValue.`set​(int index, FieldValue value)` | Replaces the element at the specified position with the new value.

    Methods in oracle.nosql.driver.values that return types with arguments of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `Set<Map.Entry<String,​FieldValue>>` | MapValue.`entrySet()` | Returns a `Set` of entries based on the underlying map that holds the values.
    `Map<String,​FieldValue>` | MapValue.`getMap()` | Returns a live `Map` of the MapValue state.
    `Iterator<FieldValue>` | ArrayValue.`iterator()` |
    `Collection<FieldValue>` | MapValue.`values()` | Returns a `Collection` of `FieldValue` instances contained in this map.

    Methods in oracle.nosql.driver.values with parameters of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `ArrayValue` | ArrayValue.`add​(int index, FieldValue value)` | Inserts the field at the specified index.
    `ArrayValue` | ArrayValue.`add​(FieldValue value)` | Adds the field to the end of the array
    `int` | ArrayValue.`compareTo​(FieldValue other)` |
    `int` | BinaryValue.`compareTo​(FieldValue other)` | Returns 0 if the two values are equal in terms of length and byte content, otherwise it returns -1.
    `int` | BooleanValue.`compareTo​(FieldValue other)` |
    `int` | DoubleValue.`compareTo​(FieldValue other)` |
    `int` | EmptyValue.`compareTo​(FieldValue other)` |
    `int` | IntegerValue.`compareTo​(FieldValue other)` |
    `int` | JsonNullValue.`compareTo​(FieldValue other)` |
    `int` | LongValue.`compareTo​(FieldValue other)` |
    `int` | MapValue.`compareTo​(FieldValue other)` |
    `int` | NullValue.`compareTo​(FieldValue other)` |
    `int` | NumberValue.`compareTo​(FieldValue other)` |
    `int` | StringValue.`compareTo​(FieldValue other)` |
    `int` | TimestampValue.`compareTo​(FieldValue other)` |
    `static void` | FieldValueEventHandler.`generate​(FieldValue value, FieldValueEventHandler handler)` | Generates events from a `FieldValue` instance sending them to the `FieldValueEventHandler` provided.
    `static void` | FieldValueEventHandler.`generate​(FieldValue value, FieldValueEventHandler handler, boolean skip)` | Generates events from a `FieldValue` instance sending them to the `FieldValueEventHandler` provided.
    `MapValue` | MapValue.`put​(String name, FieldValue value)` | Sets the named field.
    `FieldValue` | ArrayValue.`set​(int index, FieldValue value)` | Replaces the element at the specified position with the new value.

    Method parameters in oracle.nosql.driver.values with type arguments of type FieldValue
    Modifier and Type | Method | Description
    --- | --- | ---
    `ArrayValue` | ArrayValue.`addAll​(int index, Iterator<? extends FieldValue> iter)` | Inserts all of the elements in the specified Iterator into the array, starting at the specified position.
    `ArrayValue` | ArrayValue.`addAll​(int index, Stream<? extends FieldValue> stream)` | Inserts all of the elements in the specified Stream into the array, starting at the specified position.
    `ArrayValue` | ArrayValue.`addAll​(Iterator<? extends FieldValue> iter)` | Adds all of the values in the Iterator to the end of the array in the order they are returned by the iterator.
    `ArrayValue` | ArrayValue.`addAll​(Stream<? extends FieldValue> stream)` | Adds all of the values in the Stream to the end of the array in the order they are returned by the stream.
    `MapValue` | MapValue.`addAll​(Iterator<Map.Entry<String,​FieldValue>> iter)` | Inserts all of the entries in the specified iterator into the map.
    `MapValue` | MapValue.`addAll​(Stream<Map.Entry<String,​FieldValue>> stream)` | Inserts all of the entries in the specified stream into the map.