org.neo4j.storageengine.api

Interface StorageProperty

public interface StorageProperty

Abstraction pairing property key token id and property value. Can represent both defined and undefined property values, distinguished by isDefined(). Undefined property instances can be used for passing property key id and signaling that it doesn't exist.

Method Summary

Modifier and Type	Method and Description
boolean	isDefined()
int	propertyKeyId()
Object	value()
Object	value(Object defaultValue)
String	valueAsString()
boolean	valueEquals(Object other)

Method Detail

propertyKeyId

int propertyKeyId()

Returns:

property key token id for this property.

valueEquals

boolean valueEquals(Object other)

Parameters:

other - value to compare with for equality.

Returns:

whether or not the property value is equal to the given value.

value

Object value()
      throws org.neo4j.kernel.api.exceptions.PropertyNotFoundException

Returns:

the property value.

Throws:

org.neo4j.kernel.api.exceptions.PropertyNotFoundException - if this property instance represented a non-existent property.

value

Object value(Object defaultValue)

Parameters:

defaultValue - value to return if this property has no value associated with it, instead of throwing exception.

Returns:

the property value.

valueAsString

String valueAsString()
              throws org.neo4j.kernel.api.exceptions.PropertyNotFoundException

Returns:

the property value as, a String representation of it.

Throws:

org.neo4j.kernel.api.exceptions.PropertyNotFoundException - if this property instance represented a non-existent property.

isDefined

boolean isDefined()

Returns:

whether or not the property is defined, e.g. if it exists (has a value) or not.