org.neo4j.driver.v1

Class Values

java.lang.Object

org.neo4j.driver.v1.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

Method Summary

Methods

Modifier and Type	Method and Description
static org.neo4j.driver.v1.util.Function<Value,Boolean>	ofBoolean() Converts values to Boolean.
static org.neo4j.driver.v1.util.Function<Value,Double>	ofDouble() Converts values to Double.
static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Entity>	ofEntity() Converts values to Entity.
static org.neo4j.driver.v1.util.Function<Value,Long>	ofEntityId() Converts values to entity id.
static org.neo4j.driver.v1.util.Function<Value,Float>	ofFloat() Converts values to Float.
static org.neo4j.driver.v1.util.Function<Value,Integer>	ofInteger() Converts values to Integer.
static org.neo4j.driver.v1.util.Function<Value,List<Object>>	ofList() Converts values to List of Object.
static <T> org.neo4j.driver.v1.util.Function<Value,List<T>>	ofList(org.neo4j.driver.v1.util.Function<Value,T> innerMap) Converts values to List of T.
static org.neo4j.driver.v1.util.Function<Value,Long>	ofLong() Converts values to Long.
static org.neo4j.driver.v1.util.Function<Value,Map<String,Object>>	ofMap() Converts values to Map.
static <T> org.neo4j.driver.v1.util.Function<Value,Map<String,T>>	ofMap(org.neo4j.driver.v1.util.Function<Value,T> valueConverter) Converts values to Map, with the map values further converted using the provided converter.
static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Node>	ofNode() Converts values to Node.
static org.neo4j.driver.v1.util.Function<Value,Number>	ofNumber() Converts values to Number.
static org.neo4j.driver.v1.util.Function<Value,Object>	ofObject() Converts values to objects using Value.asObject().
static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Path>	ofPath() Converts values to Path.
static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Relationship>	ofRelationship() Converts values to Relationship.
static org.neo4j.driver.v1.util.Function<Value,String>	ofString() Converts values to String.
static org.neo4j.driver.v1.util.Function<Value,String>	ofToString() Converts values using Value.toString(), a human-readable string description of any value.
static org.neo4j.driver.v1.util.Function<Value,Value>	ofValue() The identity function for value conversion - returns the value untouched.
static Value	parameters(Object... keysAndValues) Helper function for creating a map of parameters, this can be used when you run statements.
static Value	value(boolean... input)
static Value	value(boolean val)
static Value	value(double... input)
static Value	value(double val)
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(long... input)
static Value	value(long val)
static Value	value(Map<String,Object> val)
static Value	value(Object value)
static Value	value(String... input)
static Value	value(String val)
static Value	value(Value... input)
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 Value value(String... input)

value

public static Value value(boolean... 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(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)

parameters

public static Value parameters(Object... keysAndValues)

Helper function for creating a map of parameters, this can be used when you run statements.

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:

StatementRunner.run(String, Value)

ofValue

public static org.neo4j.driver.v1.util.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 org.neo4j.driver.v1.util.Function<Value,Object> ofObject()

Converts values to objects using Value.asObject().

Returns:

a function that returns Value.asObject() of a Value

ofNumber

public static org.neo4j.driver.v1.util.Function<Value,Number> ofNumber()

Converts values to Number.

Returns:

a function that returns Value.asNumber() of a Value

ofString

public static org.neo4j.driver.v1.util.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 org.neo4j.driver.v1.util.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 org.neo4j.driver.v1.util.Function<Value,Integer> ofInteger()

Converts values to Integer.

Returns:

a function that returns Value.asInt() of a Value

ofLong

public static org.neo4j.driver.v1.util.Function<Value,Long> ofLong()

Converts values to Long.

Returns:

a function that returns Value.asLong() of a Value

ofFloat

public static org.neo4j.driver.v1.util.Function<Value,Float> ofFloat()

Converts values to Float.

Returns:

a function that returns Value.asFloat() of a Value

ofDouble

public static org.neo4j.driver.v1.util.Function<Value,Double> ofDouble()

Converts values to Double.

Returns:

a function that returns Value.asDouble() of a Value

ofBoolean

public static org.neo4j.driver.v1.util.Function<Value,Boolean> ofBoolean()

Converts values to Boolean.

Returns:

a function that returns Value.asBoolean() of a Value

ofMap

public static org.neo4j.driver.v1.util.Function<Value,Map<String,Object>> ofMap()

Converts values to Map.

Returns:

a function that returns MapAccessor.asMap() of a Value

ofMap

public static <T> org.neo4j.driver.v1.util.Function<Value,Map<String,T>> ofMap(org.neo4j.driver.v1.util.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 org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Entity> ofEntity()

Converts values to Entity.

Returns:

a function that returns Value.asEntity() of a Value

ofEntityId

public static org.neo4j.driver.v1.util.Function<Value,Long> ofEntityId()

Converts values to entity id.

Returns:

a function that returns the id an entity Value

ofNode

public static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Node> ofNode()

Converts values to Node.

Returns:

a function that returns Value.asNode() of a Value

ofRelationship

public static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Relationship> ofRelationship()

Converts values to Relationship.

Returns:

a function that returns Value.asRelationship() of a Value

ofPath

public static org.neo4j.driver.v1.util.Function<Value,org.neo4j.driver.v1.types.Path> ofPath()

Converts values to Path.

Returns:

a function that returns Value.asPath() of a Value

ofList

public static org.neo4j.driver.v1.util.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> org.neo4j.driver.v1.util.Function<Value,List<T>> ofList(org.neo4j.driver.v1.util.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