Value (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.spanner.Value

All Implemented Interfaces:

Serializable
```
@Immutable
public abstract class Value
extends Object
implements Serializable
```
Represents a value to be consumed by the Cloud Spanner API. A value can be NULL or non-NULL; regardless, values always have an associated type.
The Value API is optimized for construction, since this is the majority use-case when using this class with the Cloud Spanner libraries. The factory method signatures and internal representations are design to minimize memory usage and object creation while still maintaining the immutability contract of this class. In particular, arrays of primitive types can be constructed without requiring boxing into collections of wrapper types. The getters in this class are intended primarily for test purposes, and so do not share the same performance characteristics; in particular, getters for array types may be expensive.
Value instances are immutable.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static com.google.cloud.Timestamp`	`COMMIT_TIMESTAMP` Placeholder value to be passed to a mutation to make Cloud Spanner store the commit timestamp in that column.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Value`	`bool(boolean v)` Returns a `BOOL` value.
`static Value`	`bool(Boolean v)` Returns a `BOOL` value.
`static Value`	`boolArray(boolean[] v)` Returns an `ARRAY<BOOL>` value.
`static Value`	`boolArray(boolean[] v, int pos, int length)` Returns an `ARRAY<BOOL>` value that takes its elements from a region of an array.
`static Value`	`boolArray(Iterable<Boolean> v)` Returns an `ARRAY<BOOL>` value.
`static Value`	`bytes(com.google.cloud.ByteArray v)` Returns a `BYTES` value.
`static Value`	`bytesArray(Iterable<com.google.cloud.ByteArray> v)` Returns an `ARRAY<BYTES>` value.
`static Value`	`date(com.google.cloud.Date v)` Returns a `DATE` value.
`static Value`	`dateArray(Iterable<com.google.cloud.Date> v)` Returns an `ARRAY<DATE>` value.
`static Value`	`float64(double v)` Returns a `FLOAT64` value.
`static Value`	`float64(Double v)` Returns a `FLOAT64` value.
`static Value`	`float64Array(double[] v)` Returns an `ARRAY<FLOAT64>` value.
`static Value`	`float64Array(double[] v, int pos, int length)` Returns an `ARRAY<FLOAT64>` value that takes its elements from a region of an array.
`static Value`	`float64Array(Iterable<Double> v)` Returns an `ARRAY<FLOAT64>` value.
`abstract boolean`	`getBool()` Returns the value of a `BOOL`-typed instance.
`abstract List<Boolean>`	`getBoolArray()` Returns the value of an `ARRAY<BOOL>`-typed instance.
`abstract com.google.cloud.ByteArray`	`getBytes()` Returns the value of a `BYTES`-typed instance.
`abstract List<com.google.cloud.ByteArray>`	`getBytesArray()` Returns the value of an `ARRAY<BYTES>`-typed instance.
`abstract com.google.cloud.Date`	`getDate()` Returns the value of a `DATE`-typed instance.
`abstract List<com.google.cloud.Date>`	`getDateArray()` Returns the value of an `ARRAY<DATE>`-typed instance.
`abstract double`	`getFloat64()` Returns the value of a `FLOAT64`-typed instance.
`abstract List<Double>`	`getFloat64Array()` Returns the value of an `ARRAY<FLOAT64>`-typed instance.
`abstract long`	`getInt64()` Returns the value of a `INT64`-typed instance.
`abstract List<Long>`	`getInt64Array()` Returns the value of an `ARRAY<INT64>`-typed instance.
`abstract String`	`getString()` Returns the value of a `STRING`-typed instance.
`abstract List<String>`	`getStringArray()` Returns the value of an `ARRAY<STRING>`-typed instance.
`abstract Struct`	`getStruct()` Returns the value of a `STRUCT`-typed instance.
`abstract com.google.cloud.Timestamp`	`getTimestamp()` Returns the value of a `TIMESTAMP`-typed instance.
`abstract List<com.google.cloud.Timestamp>`	`getTimestampArray()` Returns the value of an `ARRAY<TIMESTAMP>`-typed instance.
`abstract Type`	`getType()` Returns the type of this value.
`static Value`	`int64(long v)` Returns an `INT64` value.
`static Value`	`int64(Long v)` Returns an `INT64` value.
`static Value`	`int64Array(Iterable<Long> v)` Returns an `ARRAY<INT64>` value.
`static Value`	`int64Array(long[] v)` Returns an `ARRAY<INT64>` value.
`static Value`	`int64Array(long[] v, int pos, int length)` Returns an `ARRAY<INT64>` value that takes its elements from a region of an array.
`abstract boolean`	`isCommitTimestamp()` Returns true if this is a commit timestamp value.
`abstract boolean`	`isNull()` Returns `true` if this instance represents a `NULL` value.
`static Value`	`string(String v)` Returns a `STRING` value.
`static Value`	`stringArray(Iterable<String> v)` Returns an `ARRAY<STRING>` value.
`static Value`	`struct(Struct v)` Returns a non-`NULL` {#code STRUCT} value.
`static Value`	`struct(Type type, Struct v)` Returns a `STRUCT` value of `Type` type.
`static Value`	`structArray(Type elementType, Iterable<Struct> v)` Returns an `ARRAY<STRUCT<...>>` value.
`static Value`	`timestamp(com.google.cloud.Timestamp v)` Returns a `TIMESTAMP` value.
`static Value`	`timestampArray(Iterable<com.google.cloud.Timestamp> v)` Returns an `ARRAY<TIMESTAMP>` value.
`String`	`toString()`

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

- Field Detail
  - COMMIT_TIMESTAMP
```
public static final com.google.cloud.Timestamp COMMIT_TIMESTAMP
```
    Placeholder value to be passed to a mutation to make Cloud Spanner store the commit timestamp in that column. The commit timestamp is the timestamp corresponding to when Cloud Spanner commits the transaction containing the mutation.
    Note that this particular timestamp instance has no semantic meaning. In particular the value of seconds and nanoseconds in this timestamp are meaningless. This placeholder can only be used for columns that have set the option "(allow_commit_timestamp=true)" in the schema.
    When reading the value stored in such a column, the value returned is an actual timestamp corresponding to the commit time of the transaction, which has no relation to this placeholder.
    
    See Also:
    
    Transaction Semantics
- Method Detail
  - bool
```
public static Value bool(@Nullable
                         Boolean v)
```
    Returns a BOOL value.
    
    Parameters:
    
    v - the value, which may be null
  - bool
```
public static Value bool(boolean v)
```
    Returns a BOOL value.
  - int64
```
public static Value int64(@Nullable
                          Long v)
```
    Returns an INT64 value.
    
    Parameters:
    
    v - the value, which may be null
  - int64
```
public static Value int64(long v)
```
    Returns an INT64 value.
  - float64
```
public static Value float64(@Nullable
                            Double v)
```
    Returns a FLOAT64 value.
    
    Parameters:
    
    v - the value, which may be null
  - float64
```
public static Value float64(double v)
```
    Returns a FLOAT64 value.
  - string
```
public static Value string(@Nullable
                           String v)
```
    Returns a STRING value.
    
    Parameters:
    
    v - the value, which may be null
  - bytes
```
public static Value bytes(@Nullable
                          com.google.cloud.ByteArray v)
```
    Returns a BYTES value.
    
    Parameters:
    
    v - the value, which may be null
  - timestamp
```
public static Value timestamp(@Nullable
                              com.google.cloud.Timestamp v)
```
    Returns a TIMESTAMP value.
  - date
```
public static Value date(@Nullable
                         com.google.cloud.Date v)
```
    Returns a DATE value. The range [1678-01-01, 2262-01-01) is the legal interval for cloud spanner dates. A write to a date column is rejected if the value is outside of that interval.
  - struct
```
public static Value struct(Struct v)
```
    Returns a non-NULL {#code STRUCT} value.
  - struct
```
public static Value struct(Type type,
                           @Nullable
                           Struct v)
```
    Returns a STRUCT value of Type type.
    
    Parameters:
    
    type - the type of the STRUCT value
    
    v - the struct STRUCT value. This may be null to produce a value for which isNull() is true. If non-null, StructReader.getType() must match type.
  - boolArray
```
public static Value boolArray(@Nullable
                              boolean[] v)
```
    Returns an ARRAY<BOOL> value.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
  - boolArray
```
public static Value boolArray(@Nullable
                              boolean[] v,
                              int pos,
                              int length)
```
    Returns an ARRAY<BOOL> value that takes its elements from a region of an array.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
    
    pos - the start position of v to copy values from. Ignored if v is null.
    
    length - the number of values to copy from v. Ignored if v is null.
  - boolArray
```
public static Value boolArray(@Nullable
                              Iterable<Boolean> v)
```
    Returns an ARRAY<BOOL> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - int64Array
```
public static Value int64Array(@Nullable
                               long[] v)
```
    Returns an ARRAY<INT64> value.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
  - int64Array
```
public static Value int64Array(@Nullable
                               long[] v,
                               int pos,
                               int length)
```
    Returns an ARRAY<INT64> value that takes its elements from a region of an array.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
    
    pos - the start position of v to copy values from. Ignored if v is null.
    
    length - the number of values to copy from v. Ignored if v is null.
  - int64Array
```
public static Value int64Array(@Nullable
                               Iterable<Long> v)
```
    Returns an ARRAY<INT64> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - float64Array
```
public static Value float64Array(@Nullable
                                 double[] v)
```
    Returns an ARRAY<FLOAT64> value.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
  - float64Array
```
public static Value float64Array(@Nullable
                                 double[] v,
                                 int pos,
                                 int length)
```
    Returns an ARRAY<FLOAT64> value that takes its elements from a region of an array.
    
    Parameters:
    
    v - the source of element values, which may be null to produce a value for which isNull() is true
    
    pos - the start position of v to copy values from. Ignored if v is null.
    
    length - the number of values to copy from v. Ignored if v is null.
  - float64Array
```
public static Value float64Array(@Nullable
                                 Iterable<Double> v)
```
    Returns an ARRAY<FLOAT64> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - stringArray
```
public static Value stringArray(@Nullable
                                Iterable<String> v)
```
    Returns an ARRAY<STRING> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - bytesArray
```
public static Value bytesArray(@Nullable
                               Iterable<com.google.cloud.ByteArray> v)
```
    Returns an ARRAY<BYTES> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - timestampArray
```
public static Value timestampArray(@Nullable
                                   Iterable<com.google.cloud.Timestamp> v)
```
    Returns an ARRAY<TIMESTAMP> value.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - dateArray
```
public static Value dateArray(@Nullable
                              Iterable<com.google.cloud.Date> v)
```
    Returns an ARRAY<DATE> value. The range [1678-01-01, 2262-01-01) is the legal interval for cloud spanner dates. A write to a date column is rejected if the value is outside of that interval.
    
    Parameters:
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - structArray
```
public static Value structArray(Type elementType,
                                @Nullable
                                Iterable<Struct> v)
```
    Returns an ARRAY<STRUCT<...>> value.
    
    Parameters:
    
    elementType -
    
    v - the source of element values. This may be null to produce a value for which isNull() is true. Individual elements may also be null.
  - getType
```
public abstract Type getType()
```
    Returns the type of this value. This will return a type even if isNull() is true.
  - isNull
```
public abstract boolean isNull()
```
    Returns true if this instance represents a NULL value.
  - getBool
```
public abstract boolean getBool()
```
    Returns the value of a BOOL-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getInt64
```
public abstract long getInt64()
```
    Returns the value of a INT64-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getFloat64
```
public abstract double getFloat64()
```
    Returns the value of a FLOAT64-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getString
```
public abstract String getString()
```
    Returns the value of a STRING-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getBytes
```
public abstract com.google.cloud.ByteArray getBytes()
```
    Returns the value of a BYTES-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getTimestamp
```
public abstract com.google.cloud.Timestamp getTimestamp()
```
    Returns the value of a TIMESTAMP-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type or isCommitTimestamp().
  - isCommitTimestamp
```
public abstract boolean isCommitTimestamp()
```
    Returns true if this is a commit timestamp value.
  - getDate
```
public abstract com.google.cloud.Date getDate()
```
    Returns the value of a DATE-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getStruct
```
public abstract Struct getStruct()
```
    Returns the value of a STRUCT-typed instance.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getBoolArray
```
public abstract List<Boolean> getBoolArray()
```
    Returns the value of an ARRAY<BOOL>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getInt64Array
```
public abstract List<Long> getInt64Array()
```
    Returns the value of an ARRAY<INT64>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getFloat64Array
```
public abstract List<Double> getFloat64Array()
```
    Returns the value of an ARRAY<FLOAT64>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getStringArray
```
public abstract List<String> getStringArray()
```
    Returns the value of an ARRAY<STRING>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getBytesArray
```
public abstract List<com.google.cloud.ByteArray> getBytesArray()
```
    Returns the value of an ARRAY<BYTES>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getTimestampArray
```
public abstract List<com.google.cloud.Timestamp> getTimestampArray()
```
    Returns the value of an ARRAY<TIMESTAMP>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - getDateArray
```
public abstract List<com.google.cloud.Date> getDateArray()
```
    Returns the value of an ARRAY<DATE>-typed instance. While the returned list itself will never be null, elements of that list may be null.
    
    Throws:
    
    IllegalStateException - if isNull() or the value is not of the expected type
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Value

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMIT_TIMESTAMP

Method Detail

bool

bool

int64

int64

float64

float64

string

bytes

timestamp

date

struct

struct

boolArray

boolArray

boolArray

int64Array

int64Array

int64Array

float64Array

float64Array

float64Array

stringArray

bytesArray

timestampArray

dateArray

structArray

getType

isNull

getBool

getInt64

getFloat64

getString

getBytes

getTimestamp

isCommitTimestamp

getDate

getStruct

getBoolArray

getInt64Array

getFloat64Array

getStringArray

getBytesArray

getTimestampArray

getDateArray

toString