Class EntityValueAdapter<V extends Entity>

java.lang.Object

org.neo4j.driver.internal.types.InternalMapAccessorWithDefaultValue

org.neo4j.driver.internal.value.ValueAdapter

org.neo4j.driver.internal.value.ObjectValueAdapter<V>

org.neo4j.driver.internal.value.EntityValueAdapter<V>

All Implemented Interfaces:

org.neo4j.bolt.connection.values.Value, InternalValue, MapAccessor, MapAccessorWithDefaultValue, Value

Direct Known Subclasses:

NodeValue, RelationshipValue

public abstract class EntityValueAdapter<V extends Entity>
extends ObjectValueAdapter<V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityValueAdapter(V adapted)

Method Summary

Modifier and Type	Method	Description
V	asEntity()	Returns the value as a Entity, if possible.
Map<String,Object>	asMap()	Return the underlying map as a map of string keys and values converted using Value.asObject().
<T> Map<String,T>	asMap(Function<Value,T> mapFunction)	Return the underlying map as a map of string keys and values converted using the supplied function.
Value	get(String key)	Retrieve the value of the property with the given key
Iterable<String>	keys()	Retrieve the keys of the underlying map
int	size()	Retrieve the number of entries in this map

Methods inherited from class ObjectValueAdapter

asObject, equals, hashCode, toString

Modifier and Type	Method	Description
final V	asObject()	This returns a java standard library representation of the underlying value, using a java type that is "sensible" given the underlying type.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class ValueAdapter

asBoltVector, asBoolean, asBoolean, asByteArray, asByteArray, asDouble, asDouble, asFloat, asFloat, asInt, asInt, asIsoDuration, asIsoDuration, asList, asList, asList, asList, asLocalDate, asLocalDate, asLocalDateTime, asLocalDateTime, asLocalTime, asLocalTime, asLong, asLong, asMap, asMap, asMapped, asNode, asNumber, asOffsetDateTime, asOffsetDateTime, asOffsetTime, asOffsetTime, asPath, asPoint, asPoint, asRelationship, asString, asString, asUnsupportedType, asUUID, asValue, asVector, asZonedDateTime, asZonedDateTime, computeOrDefault, containsKey, get, hasType, isEmpty, isFalse, isNull, isTrue, typeConstructor, values, values

Modifier and Type	Method	Description
org.neo4j.bolt.connection.values.Vector	asBoltVector()
boolean	asBoolean()	Returns the value as a Java boolean, if possible.
boolean	asBoolean(boolean defaultValue)	Returns the value as a Java boolean, if possible.
byte[]	asByteArray()	Returns the value as a Java byte array, if possible.
byte[]	asByteArray(byte[] defaultValue)	Returns the value as a Java byte array, if possible.
double	asDouble()	Returns a Java double if no precision is lost in the conversion.
double	asDouble(double defaultValue)	Returns a Java double if no precision is lost in the conversion.
float	asFloat()	Returns a Java float if no precision is lost in the conversion.
float	asFloat(float defaultValue)	Returns a Java float if no precision is lost in the conversion.
int	asInt()	Returns a Java int if no precision is lost in the conversion.
int	asInt(int defaultValue)	Returns a Java int if no precision is lost in the conversion.
IsoDuration	asIsoDuration()	Returns the value as a IsoDuration, if possible.
IsoDuration	asIsoDuration(IsoDuration defaultValue)	Returns the value as a IsoDuration, if possible.
List<Object>	asList()	If the underlying type can be viewed as a list, returns a java list of values, where each value has been converted using Value.asObject().
<T> List<T>	asList(Function<Value,T> mapFunction)	Returns the value as a list of T obtained by mapping from the list elements, if possible.
<T> List<T>	asList(Function<Value,T> mapFunction, List<T> defaultValue)	Returns the value as a list of T obtained by mapping from the list elements, if possible.
List<Object>	asList(List<Object> defaultValue)	If the underlying type can be viewed as a list, returns a java list of values, where each value has been converted using Value.asObject().
LocalDate	asLocalDate()	Returns the value as a LocalDate, if possible.
LocalDate	asLocalDate(LocalDate defaultValue)	Returns the value as a LocalDate, if possible.
LocalDateTime	asLocalDateTime()	Returns the value as a LocalDateTime, if possible.
LocalDateTime	asLocalDateTime(LocalDateTime defaultValue)	Returns the value as a LocalDateTime, if possible.
LocalTime	asLocalTime()	Returns the value as a LocalTime, if possible.
LocalTime	asLocalTime(LocalTime defaultValue)	Returns the value as a LocalTime, if possible.
long	asLong()	Returns a Java long if no precision is lost in the conversion.
long	asLong(long defaultValue)	Returns a Java long if no precision is lost in the conversion.
<T> Map<String,T>	asMap(Function<Value,T> mapFunction, Map<String,T> defaultValue)	Returns the value as a map from string keys to values of type T obtained from mapping he original map values, if possible.
Map<String,Object>	asMap(Map<String,Object> defaultValue)	Return as a map of string keys and values converted using Value.asObject().
protected <T> T	asMapped(Class<T> targetClass)
Node	asNode()	Returns the value as a Node, if possible.
Number	asNumber()	Returns the value as a Java Number, if possible.
OffsetDateTime	asOffsetDateTime()	Returns the value as a OffsetDateTime, if possible.
OffsetDateTime	asOffsetDateTime(OffsetDateTime defaultValue)	Returns the value as a OffsetDateTime, if possible.
OffsetTime	asOffsetTime()	Returns the value as a OffsetTime, if possible.
OffsetTime	asOffsetTime(OffsetTime defaultValue)	Returns the value as a OffsetTime, if possible.
Path	asPath()	Returns the value as a Path, if possible.
Point	asPoint()	Returns the value as a Point, if possible.
Point	asPoint(Point defaultValue)	Returns the value as a Point, if possible.
Relationship	asRelationship()	Returns the value as a Relationship, if possible.
String	asString()	Returns the value as a Java String, if possible.
String	asString(String defaultValue)	Returns the value as a Java String, if possible.
UnsupportedType	asUnsupportedType()	Returns the value as an UnsupportedType, if possible.
UUID	asUUID()	Returns the value as a UUID, if possible.
Value	asValue()
Vector	asVector()	Returns the value as an Vector, if possible.
ZonedDateTime	asZonedDateTime()	Returns the value as a ZonedDateTime, if possible.
ZonedDateTime	asZonedDateTime(ZonedDateTime defaultValue)	Returns the value as a ZonedDateTime, if possible.
<T> T	computeOrDefault(Function<Value,T> mapper, T defaultValue)	Apply the mapping function on the value if the value is not a NullValue, or the default value if the value is a NullValue.
boolean	containsKey(String key)	Check if the list of keys contains the given key
Value	get(int index)	Retrieve the value at the given index
boolean	hasType(Type type)	Test if this value is a value of the given type.
boolean	isEmpty()	If this value represents a list or map, test if the collection is empty.
boolean	isFalse()	Returns true if the value is a Boolean value and has the value False.
boolean	isNull()	Returns true if the value is a Null, otherwise false.
boolean	isTrue()	Returns true if the value is a Boolean value and has the value True.
final TypeConstructor	typeConstructor()
Iterable<Value>	values()	Retrieve all values of the underlying collection
<T> Iterable<T>	values(Function<Value,T> mapFunction)	Map and retrieve all values of the underlying collection

Methods inherited from class InternalMapAccessorWithDefaultValue

get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get

Modifier and Type	Method	Description
boolean	get(String key, boolean defaultValue)	Retrieve the java boolean with the given key.
double	get(String key, double defaultValue)	Retrieve the java double number with the given key.
float	get(String key, float defaultValue)	Retrieve the java float number with the given key.
int	get(String key, int defaultValue)	Retrieve the java integer with the given key.
long	get(String key, long defaultValue)	Retrieve the java long number with the given key.
Number	get(String key, Number defaultValue)	Retrieve the number with the given key.
Object	get(String key, Object defaultValue)	Retrieve the object with the given key.
String	get(String key, String defaultValue)	Retrieve the java string with the given key.
List<Object>	get(String key, List<Object> defaultValue)	Retrieve the list of objects with the given key.
<T> List<T>	get(String key, List<T> defaultValue, Function<Value,T> mapFunc)	Retrieve the list with the given key.
Map<String,Object>	get(String key, Map<String,Object> defaultValue)	Retrieve the map with the given key.
<T> Map<String,T>	get(String key, Map<String,T> defaultValue, Function<Value,T> mapFunc)	Retrieve the map with the given key.
Entity	get(String key, Entity defaultValue)	Retrieve the entity with the given key.
Node	get(String key, Node defaultValue)	Retrieve the node with the given key.
Path	get(String key, Path defaultValue)	Retrieve the path with the given key.
Relationship	get(String key, Relationship defaultValue)	Retrieve the value with the given key.
Value	get(String key, Value defaultValue)	Retrieve the value with the given key.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface InternalValue

as, as, asBoltIsoDuration, asBoltMap, asBoltPoint, boltValues, getBoltValue

Modifier and Type	Method	Description
default Object	as(ParameterizedType type)
default Object	as(Type type)
default org.neo4j.bolt.connection.values.IsoDuration	asBoltIsoDuration()
default Map<String, org.neo4j.bolt.connection.values.Value>	asBoltMap()
default org.neo4j.bolt.connection.values.Point	asBoltPoint()
default Iterable<org.neo4j.bolt.connection.values.Value>	boltValues()
default org.neo4j.bolt.connection.values.Value	getBoltValue(String key)

Methods inherited from interface org.neo4j.bolt.connection.values.Value

boltValueType

Methods inherited from interface Value

as, type

Modifier and Type	Method	Description
default <T> T	as(Class<T> targetClass)	Maps this value to the given type providing that is it supported.
Type	type()	Returns the type of this value as defined in the Neo4j type system.

Constructor Details

EntityValueAdapter

protected EntityValueAdapter(V adapted)

Method Details

asEntity

public V asEntity()

Description copied from interface: Value

Returns the value as a Entity, if possible.

Specified by:

asEntity in interface Value

Overrides:

asEntity in class ValueAdapter

Returns:

the value as a Entity, if possible

asMap

public Map<String,Object> asMap()

Description copied from interface: MapAccessor

Return the underlying map as a map of string keys and values converted using Value.asObject().

This is equivalent to calling MapAccessor.asMap(Function) with Values.ofObject().

Specified by:

asMap in interface MapAccessor

Overrides:

asMap in class ValueAdapter

Returns:

the value as a Java map

asMap

public <T> Map<String,T> asMap(Function<Value,T> mapFunction)

Description copied from interface: MapAccessor

Return the underlying map as a map of string keys and values converted using the supplied function.

Specified by:

asMap in interface MapAccessor

Overrides:

asMap in class ValueAdapter

Type Parameters:

T - the type of map values

Parameters:

mapFunction - a function to map from Value to T. See Values for some predefined functions, such as Values.ofBoolean(), Values.ofList(Function).

Returns:

the value as a map from string keys to values of type T obtained from mapping the original map values, if possible

See Also:

• for a long list of built-in conversion functions

size

public int size()

Description copied from interface: MapAccessor

Retrieve the number of entries in this map

Specified by:

size in interface MapAccessor

Specified by:

size in interface Value

Overrides:

size in class ValueAdapter

Returns:

the number of entries in this map

keys

public Iterable<String> keys()

Description copied from interface: MapAccessor

Retrieve the keys of the underlying map

Specified by:

keys in interface MapAccessor

Specified by:

keys in interface Value

Overrides:

keys in class ValueAdapter

Returns:

all map keys in unspecified order

get

public Value get(String key)

Description copied from interface: MapAccessor

Retrieve the value of the property with the given key

Specified by:

get in interface MapAccessor

Overrides:

get in class ValueAdapter

Parameters:

key - the key of the property

Returns:

the property's value or a NullValue if no such key exists