Module org.neo4j.driver

Package org.neo4j.driver.internal.value

Class ListValue

java.lang.Object

org.neo4j.driver.internal.types.InternalMapAccessorWithDefaultValue

org.neo4j.driver.internal.value.ValueAdapter

org.neo4j.driver.internal.value.ListValue

All Implemented Interfaces:

org.neo4j.driver.internal.AsValue, InternalValue, MapAccessor, MapAccessorWithDefaultValue, Value

public class ListValue
extends ValueAdapter

Constructor Summary

Constructors

Constructor	Description
ListValue(Value... values)

Method Summary

Modifier and Type	Method	Description
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)
List<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	equals(Object o)
Value	get(int index)	Retrieve the value at the given index
int	hashCode()
boolean	isEmpty()	If this value represents a list or map, test if the collection is empty.
int	size()	If the underlying value is a collection type, return the number of values in the collection.
String	toString()
Type	type()
<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, asLocalDate, asLocalDate, asLocalDateTime, asLocalDateTime, asLocalTime, asLocalTime, asLong, asLong, asMap, asMap, asMap, asMap, asNode, asNumber, asOffsetDateTime, asOffsetDateTime, asOffsetTime, asOffsetTime, asPath, asPoint, asPoint, asRelationship, asString, asString, asValue, asZonedDateTime, asZonedDateTime, computeOrDefault, containsKey, get, hasType, isFalse, isNull, isTrue, keys, typeConstructor, 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

Constructor Details

ListValue

public ListValue(Value... values)

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 List<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.

asList

public List<Object> asList()

Description copied from interface: Value

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().

Specified by:

asList in interface Value

Overrides:

asList in class ValueAdapter

Returns:

the value as a Java list of values, if possible

See Also:

• Value.asObject()

asList

public <T> List<T> asList(Function<Value,T> mapFunction)

Specified by:

asList in interface Value

Overrides:

asList in class ValueAdapter

Type Parameters:

T - the type of target list elements

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 list of T obtained by mapping from the list elements, 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

get

public Value get(int index)

Description copied from interface: Value

Retrieve the value at the given index

Specified by:

get in interface Value

Overrides:

get in class ValueAdapter

Parameters:

index - the index of the value

Returns:

the value or a NullValue if the index is out of bounds

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

type

public Type type()

Returns:

The type of this value as defined in the Neo4j type system

toString

public String toString()

Specified by:

toString in interface Value

Specified by:

toString in class ValueAdapter

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