Module org.neo4j.driver

Package org.neo4j.driver.internal.value

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.driver.internal.AsValue, 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()
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)
Value	get(String key)	Retrieve the value of the property with the given key
Iterable<String>	keys()	If the underlying value supports key-based indexing, return an iterable of the keys in the map, this applies to map, node and TypeSystem.RELATIONSHIP() relationship} values.
int	size()	If the underlying value is a collection type, return the number of values in the collection.

Methods inherited from class org.neo4j.driver.internal.value.ObjectValueAdapter

asObject, equals, hashCode, toString

Methods inherited from class org.neo4j.driver.internal.value.ValueAdapter

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, asNode, asNumber, asOffsetDateTime, asOffsetDateTime, asOffsetTime, asOffsetTime, asPath, asPoint, asPoint, asRelationship, asString, asString, asValue, asZonedDateTime, asZonedDateTime, computeOrDefault, containsKey, get, hasType, isEmpty, isFalse, isNull, isTrue, typeConstructor, values, values

Methods inherited from class org.neo4j.driver.internal.types.InternalMapAccessorWithDefaultValue

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.driver.types.MapAccessorWithDefaultValue

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

Methods inherited from interface org.neo4j.driver.Value

type

Constructor Details

EntityValueAdapter

protected EntityValueAdapter(V adapted)

Method Details

asEntity

public V asEntity()

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)

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: Value

If the underlying value is a collection type, return the number of values in the collection.

For TypeSystem.LIST() list} values, this will return the size of the list.

For map values, this will return the number of entries in the map.

For node and TypeSystem.RELATIONSHIP() relationship} values, this will return the number of properties.

For path values, this returns the length (number of relationships) in the path.

Specified by:

size in interface MapAccessor

Specified by:

size in interface Value

Overrides:

size in class ValueAdapter

Returns:

the number of values in an underlying collection

keys

public Iterable<String> keys()

Description copied from interface: Value

If the underlying value supports key-based indexing, return an iterable of the keys in the map, this applies to map, node and TypeSystem.RELATIONSHIP() relationship} values.

Specified by:

keys in interface MapAccessor

Specified by:

keys in interface Value

Overrides:

keys in class ValueAdapter

Returns:

the keys in the value

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