Values (Neo4j Java Driver 4.0.0 API)

java.lang.Object
- org.neo4j.driver.Values

```
public abstract class Values
extends Object
```
Utility for wrapping regular Java types and exposing them as Value objects, and vice versa.
The long set of ofXXX methods in this class are meant to be used as arguments for methods like Value.asList(Function), MapAccessor.asMap(Function), Record.asMap(Function) and so on.

Since:

1.0

Field Summary

Fields
Modifier and Type Field and Description

static Value EmptyMap

static Value NULL

Fields
Modifier and Type	Field and Description
`static Value`	`EmptyMap`
`static Value`	`NULL`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Value`	`isoDuration(long months, long days, long seconds, int nanoseconds)`
`static Function<Value,Boolean>`	`ofBoolean()` Converts values to `Boolean`.
`static Function<Value,Double>`	`ofDouble()` Converts values to `Double`.
`static Function<Value,Entity>`	`ofEntity()` Converts values to `Entity`.
`static Function<Value,Long>`	`ofEntityId()` Converts values to `entity id`.
`static Function<Value,Float>`	`ofFloat()` Converts values to `Float`.
`static Function<Value,Integer>`	`ofInteger()` Converts values to `Integer`.
`static Function<Value,IsoDuration>`	`ofIsoDuration()` Converts values to `IsoDuration`.
`static Function<Value,List<Object>>`	`ofList()` Converts values to `List` of `Object`.
`static <T> Function<Value,List<T>>`	`ofList(Function<Value,T> innerMap)` Converts values to `List` of `T`.
`static Function<Value,LocalDate>`	`ofLocalDate()` Converts values to `LocalDate`.
`static Function<Value,LocalDateTime>`	`ofLocalDateTime()` Converts values to `LocalDateTime`.
`static Function<Value,LocalTime>`	`ofLocalTime()` Converts values to `LocalTime`.
`static Function<Value,Long>`	`ofLong()` Converts values to `Long`.
`static Function<Value,Map<String,Object>>`	`ofMap()` Converts values to `Map`.
`static <T> Function<Value,Map<String,T>>`	`ofMap(Function<Value,T> valueConverter)` Converts values to `Map`, with the map values further converted using the provided converter.
`static Function<Value,Node>`	`ofNode()` Converts values to `Node`.
`static Function<Value,Number>`	`ofNumber()` Converts values to `Number`.
`static Function<Value,Object>`	`ofObject()` Converts values to objects using `Value.asObject()`.
`static Function<Value,OffsetDateTime>`	`ofOffsetDateTime()` Converts values to `OffsetDateTime`.
`static Function<Value,OffsetTime>`	`ofOffsetTime()` Converts values to `OffsetTime`.
`static Function<Value,Path>`	`ofPath()` Converts values to `Path`.
`static Function<Value,Point>`	`ofPoint()` Converts values to `Point`.
`static Function<Value,Relationship>`	`ofRelationship()` Converts values to `Relationship`.
`static Function<Value,String>`	`ofString()` Converts values to `String`.
`static Function<Value,String>`	`ofToString()` Converts values using `Value.toString()`, a human-readable string description of any value.
`static Function<Value,Value>`	`ofValue()` The identity function for value conversion - returns the value untouched.
`static Function<Value,ZonedDateTime>`	`ofZonedDateTime()` Converts values to `ZonedDateTime`.
`static Value`	`parameters(Object... keysAndValues)` Helper function for creating a map of parameters, this can be used when you `run` queries.
`static Value`	`point(int srid, double x, double y)`
`static Value`	`point(int srid, double x, double y, double z)`
`static Value`	`value(boolean... input)`
`static Value`	`value(boolean val)`
`static org.neo4j.driver.internal.value.BytesValue`	`value(byte... input)`
`static Value`	`value(char... input)`
`static Value`	`value(char val)`
`static Value`	`value(double... input)`
`static Value`	`value(double val)`
`static Value`	`value(Duration duration)`
`static Value`	`value(float... input)`
`static Value`	`value(int... input)`
`static Value`	`value(int val)`
`static Value`	`value(Iterable<Object> val)`
`static Value`	`value(Iterator<Object> val)`
`static Value`	`value(List<Object> vals)`
`static Value`	`value(LocalDate localDate)`
`static Value`	`value(LocalDateTime localDateTime)`
`static Value`	`value(LocalTime localTime)`
`static Value`	`value(long... input)`
`static Value`	`value(long val)`
`static Value`	`value(Map<String,Object> val)`
`static Value`	`value(Object value)`
`static Value`	`value(OffsetDateTime offsetDateTime)`
`static Value`	`value(OffsetTime offsetTime)`
`static Value`	`value(Period period)`
`static Value`	`value(Stream<Object> stream)`
`static Value`	`value(String... input)`
`static Value`	`value(String val)`
`static Value`	`value(Value... input)`
`static Value`	`value(ZonedDateTime zonedDateTime)`
`static Value[]`	`values(Object... input)`

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

- Field Detail
  - EmptyMap
```
public static final Value EmptyMap
```
  - NULL
```
public static final Value NULL
```
- Method Detail
  - value
```
public static Value value(Object value)
```
  - values
```
public static Value[] values(Object... input)
```
  - value
```
public static Value value(Value... input)
```
  - value
```
public static org.neo4j.driver.internal.value.BytesValue value(byte... input)
```
  - value
```
public static Value value(String... input)
```
  - value
```
public static Value value(boolean... input)
```
  - value
```
public static Value value(char... input)
```
  - value
```
public static Value value(long... input)
```
  - value
```
public static Value value(int... input)
```
  - value
```
public static Value value(double... input)
```
  - value
```
public static Value value(float... input)
```
  - value
```
public static Value value(List<Object> vals)
```
  - value
```
public static Value value(Iterable<Object> val)
```
  - value
```
public static Value value(Iterator<Object> val)
```
  - value
```
public static Value value(Stream<Object> stream)
```
  - value
```
public static Value value(char val)
```
  - value
```
public static Value value(String val)
```
  - value
```
public static Value value(long val)
```
  - value
```
public static Value value(int val)
```
  - value
```
public static Value value(double val)
```
  - value
```
public static Value value(boolean val)
```
  - value
```
public static Value value(Map<String,Object> val)
```
  - value
```
public static Value value(LocalDate localDate)
```
  - value
```
public static Value value(OffsetTime offsetTime)
```
  - value
```
public static Value value(LocalTime localTime)
```
  - value
```
public static Value value(LocalDateTime localDateTime)
```
  - value
```
public static Value value(OffsetDateTime offsetDateTime)
```
  - value
```
public static Value value(ZonedDateTime zonedDateTime)
```
  - value
```
public static Value value(Period period)
```
  - value
```
public static Value value(Duration duration)
```
  - isoDuration
```
public static Value isoDuration(long months,
                                long days,
                                long seconds,
                                int nanoseconds)
```
  - point
```
public static Value point(int srid,
                          double x,
                          double y)
```
  - point
```
public static Value point(int srid,
                          double x,
                          double y,
                          double z)
```
  - parameters
```
public static Value parameters(Object... keysAndValues)
```
    Helper function for creating a map of parameters, this can be used when you run queries.
    Allowed parameter types are:
    - Integer
    - Long
    - Boolean
    - Double
    - Float
    - String
    - Map with String keys and values being any type in this list
    - Collection of any type in this list
    Parameters:
    
    keysAndValues - alternating sequence of keys and values
    
    Returns:
    
    Map containing all parameters specified
    
    See Also:
    
    QueryRunner.run(String, Value)
  - ofValue
```
public static Function<Value,Value> ofValue()
```
    The identity function for value conversion - returns the value untouched.
    
    Returns:
    
    a function that returns the value passed into it - the identity function
  - ofObject
```
public static Function<Value,Object> ofObject()
```
    Converts values to objects using Value.asObject().
    
    Returns:
    
    a function that returns Value.asObject() of a Value
  - ofNumber
```
public static Function<Value,Number> ofNumber()
```
    Converts values to Number.
    
    Returns:
    
    a function that returns Value.asNumber() of a Value
  - ofString
```
public static Function<Value,String> ofString()
```
    Converts values to String.
    If you want to access a string you've retrieved from the database, this is the right choice. If you want to print any value for human consumption, for instance in a log, ofToString() is the right choice.
    
    Returns:
    
    a function that returns Value.asString() of a Value
  - ofToString
```
public static Function<Value,String> ofToString()
```
    Converts values using Value.toString(), a human-readable string description of any value.
    This is different from ofString(), which returns a java String value from a database TypeSystem.STRING().
    If you are wanting to print any value for human consumption, this is the right choice. If you are wanting to access a string value stored in the database, you should use ofString().
    
    Returns:
    
    a function that returns Value.toString() of a Value
  - ofInteger
```
public static Function<Value,Integer> ofInteger()
```
    Converts values to Integer.
    
    Returns:
    
    a function that returns Value.asInt() of a Value
  - ofLong
```
public static Function<Value,Long> ofLong()
```
    Converts values to Long.
    
    Returns:
    
    a function that returns Value.asLong() of a Value
  - ofFloat
```
public static Function<Value,Float> ofFloat()
```
    Converts values to Float.
    
    Returns:
    
    a function that returns Value.asFloat() of a Value
  - ofDouble
```
public static Function<Value,Double> ofDouble()
```
    Converts values to Double.
    
    Returns:
    
    a function that returns Value.asDouble() of a Value
  - ofBoolean
```
public static Function<Value,Boolean> ofBoolean()
```
    Converts values to Boolean.
    
    Returns:
    
    a function that returns Value.asBoolean() of a Value
  - ofMap
```
public static Function<Value,Map<String,Object>> ofMap()
```
    Converts values to Map.
    
    Returns:
    
    a function that returns MapAccessor.asMap() of a Value
  - ofMap
```
public static <T> Function<Value,Map<String,T>> ofMap(Function<Value,T> valueConverter)
```
    Converts values to Map, with the map values further converted using the provided converter.
    
    Type Parameters:
    
    T - the type of values in the returned map
    
    Parameters:
    
    valueConverter - converter to use for the values of the map
    
    Returns:
    
    a function that returns MapAccessor.asMap(Function) of a Value
  - ofEntity
```
public static Function<Value,Entity> ofEntity()
```
    Converts values to Entity.
    
    Returns:
    
    a function that returns Value.asEntity() of a Value
  - ofEntityId
```
public static Function<Value,Long> ofEntityId()
```
    Converts values to entity id.
    
    Returns:
    
    a function that returns the id an entity Value
  - ofNode
```
public static Function<Value,Node> ofNode()
```
    Converts values to Node.
    
    Returns:
    
    a function that returns Value.asNode() of a Value
  - ofRelationship
```
public static Function<Value,Relationship> ofRelationship()
```
    Converts values to Relationship.
    
    Returns:
    
    a function that returns Value.asRelationship() of a Value
  - ofPath
```
public static Function<Value,Path> ofPath()
```
    Converts values to Path.
    
    Returns:
    
    a function that returns Value.asPath() of a Value
  - ofLocalDate
```
public static Function<Value,LocalDate> ofLocalDate()
```
    Converts values to LocalDate.
    
    Returns:
    
    a function that returns Value.asLocalDate() of a Value
  - ofOffsetTime
```
public static Function<Value,OffsetTime> ofOffsetTime()
```
    Converts values to OffsetTime.
    
    Returns:
    
    a function that returns Value.asOffsetTime() of a Value
  - ofLocalTime
```
public static Function<Value,LocalTime> ofLocalTime()
```
    Converts values to LocalTime.
    
    Returns:
    
    a function that returns Value.asLocalTime() of a Value
  - ofLocalDateTime
```
public static Function<Value,LocalDateTime> ofLocalDateTime()
```
    Converts values to LocalDateTime.
    
    Returns:
    
    a function that returns Value.asLocalDateTime() of a Value
  - ofOffsetDateTime
```
public static Function<Value,OffsetDateTime> ofOffsetDateTime()
```
    Converts values to OffsetDateTime.
    
    Returns:
    
    a function that returns Value.asOffsetDateTime() of a Value
  - ofZonedDateTime
```
public static Function<Value,ZonedDateTime> ofZonedDateTime()
```
    Converts values to ZonedDateTime.
    
    Returns:
    
    a function that returns Value.asZonedDateTime() of a Value
  - ofIsoDuration
```
public static Function<Value,IsoDuration> ofIsoDuration()
```
    Converts values to IsoDuration.
    
    Returns:
    
    a function that returns Value.asIsoDuration() of a Value
  - ofPoint
```
public static Function<Value,Point> ofPoint()
```
    Converts values to Point.
    
    Returns:
    
    a function that returns Value.asPoint() of a Value
  - ofList
```
public static Function<Value,List<Object>> ofList()
```
    Converts values to List of Object.
    
    Returns:
    
    a function that returns Value.asList() of a Value
  - ofList
```
public static <T> Function<Value,List<T>> ofList(Function<Value,T> innerMap)
```
    Converts values to List of T.
    
    Type Parameters:
    
    T - the type of values inside the list
    
    Parameters:
    
    innerMap - converter for the values inside the list
    
    Returns:
    
    a function that returns Value.asList(Function) of a Value

Class Values

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EmptyMap

NULL

Method Detail

value

values

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

isoDuration

point

point

parameters

ofValue

ofObject

ofNumber

ofString

ofToString

ofInteger

ofLong

ofFloat

ofDouble

ofBoolean

ofMap

ofMap

ofEntity

ofEntityId

ofNode

ofRelationship

ofPath

ofLocalDate

ofOffsetTime

ofLocalTime

ofLocalDateTime

ofOffsetDateTime

ofZonedDateTime

ofIsoDuration

ofPoint

ofList

ofList