org.neo4j.driver.internal.value.MapValue

All Implemented Interfaces:: org.neo4j.driver.internal.AsValue, InternalValue, MapAccessor, MapAccessorWithDefaultValue, Value

public class MapValue extends ValueAdapter

Constructor Summary

Constructors

Constructor

Description

MapValue(Map<String,Value> val)
Method Summary

Modifier and Type

Method

Description

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)

Map<String,Object>

asObject()

This returns a java standard library representation of the underlying value, using a java type that is "sensible" given the underlying type.

boolean

containsKey(String key)

Check if the list of keys contains the given key

boolean

equals(Object o)

Value

get(String key)

Retrieve the value of the property with the given key

int

hashCode()

boolean

isEmpty()

If this value represents a list or map, test if the collection is empty.

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.

String

toString()

Type

type()

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 org.neo4j.driver.internal.value.ValueAdapter
asBoolean, asBoolean, asByteArray, asByteArray, asDouble, asDouble, asEntity, 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, get, hasType, isFalse, isNull, isTrue, typeConstructor

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

Constructor Details
- MapValue
  
  public MapValue(Map<String,Value> val)
Method Details
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from interface: Value
  
  If this value represents a list or map, test if the collection is empty.
  
  Specified by:
  
  isEmpty in interface Value
  
  Overrides:
  
  isEmpty in class ValueAdapter
  
  Returns:
  
  true if size() is 0, otherwise false
- asObject
  
  public Map<String,Object> asObject()
  
  Description copied from interface: Value
  This returns a java standard library representation of the underlying value, using a java type that is "sensible" given the underlying type. The mapping for common types is as follows:
  
  TypeSystem.NULL() - null
  
  TypeSystem.LIST() - List
  
  TypeSystem.MAP() - Map
  
  TypeSystem.BOOLEAN() - Boolean
  
  TypeSystem.INTEGER() - Long
  
  TypeSystem.FLOAT() - Double
  
  TypeSystem.STRING() - String
  
  TypeSystem.BYTES() - byte[]
  
  TypeSystem.DATE() - LocalDate
  
  TypeSystem.TIME() - OffsetTime
  
  TypeSystem.LOCAL_TIME() - LocalTime
  
  TypeSystem.DATE_TIME() - ZonedDateTime
  
  TypeSystem.LOCAL_DATE_TIME() - LocalDateTime
  
  TypeSystem.DURATION() - IsoDuration
  
  TypeSystem.POINT() - Point
  
  TypeSystem.NODE() - Node
  
  TypeSystem.RELATIONSHIP() - Relationship
  
  TypeSystem.PATH() - Path
  
  Note that the types in TypeSystem refers to the Neo4j type system where TypeSystem.INTEGER() and TypeSystem.FLOAT() are both 64-bit precision. This is why these types return java Long and Double, respectively.
  Specified by:
  
  asObject in interface Value
  
  Overrides:
  
  asObject in class ValueAdapter
  
  Returns:
  
  the value as a Java Object.
- 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 he 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
- containsKey
  
  public boolean containsKey(String key)
  
  Description copied from interface: MapAccessor
  
  Check if the list of keys contains the given key
  
  Specified by:
  
  containsKey in interface MapAccessor
  
  Overrides:
  
  containsKey in class ValueAdapter
  
  Parameters:
  
  key - the key
  
  Returns:
  
  true if this map keys contains the given key otherwise false
- 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
- values
  
  public Iterable<Value> values()
  
  Description copied from interface: MapAccessor
  
  Retrieve all values of the underlying collection
  
  Specified by:
  
  values in interface MapAccessor
  
  Overrides:
  
  values in class ValueAdapter
  
  Returns:
  
  all values in unspecified order
- values
  
  public <T> Iterable<T> values(Function<Value,T> mapFunction)
  
  Description copied from interface: MapAccessor
  
  Map and retrieve all values of the underlying collection
  
  Specified by:
  
  values in interface MapAccessor
  
  Overrides:
  
  values in class ValueAdapter
  
  Type Parameters:
  
  T - the target type of mapping
  
  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 result of mapping all values 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
- toString
  
  public String toString()
  
  Specified by:
  
  toString in interface Value
  
  Specified by:
  
  toString in class ValueAdapter
- type
  
  public Type type()
  
  Returns:
  
  The type of this value as defined in the Neo4j type system
- equals
  
  public boolean equals(Object o)
  
  Specified by:
  
  equals in interface Value
  
  Specified by:
  
  equals in class ValueAdapter
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in interface Value
  
  Specified by:
  
  hashCode in class ValueAdapter

Class MapValue

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

MapValue

Method Details

isEmpty

asObject

asMap

asMap

size

containsKey

keys

values

values

get

toString

type

equals

hashCode