org.neo4j.values.storable

Class Values

java.lang.Object

org.neo4j.values.storable.Values

public final class Values
extends Object

Entry point to the values library.

The values library centers around the Value class, which represents a value in Neo4j. Values can be correctly checked for equality over different primitive representations, including consistent hashCodes and sorting.

To create Values use the factory methods in the Values class.

Values come in two major categories: Storable and Virtual. Storable values are valid values for node, relationship and graph properties. Virtual values are not supported as property values, but might be created and returned as part of cypher execution. These include Node, Relationship and Path.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Value>	COMPARATOR Default value comparator.
static Value	MAX_NUMBER
static Value	MAX_STRING
static Value	MIN_NUMBER
static Value	MIN_STRING
static Value	NO_VALUE

Method Summary

Modifier and Type	Method and Description
static Object	asObject(Value value) Deprecated.
static Object[]	asObjects(Value[] propertyValues)
static Value	booleanArray(boolean[] value)
static Value	booleanValue(boolean value)
static Value	byteArray(byte[] value)
static Value	byteValue(byte value)
static Value	charArray(char[] value)
static Value	charValue(char value)
static double	coerceToDouble(Value value)
static Value	doubleArray(double[] value)
static Value	doubleValue(double value)
static Value	floatArray(float[] value)
static Value	floatValue(float value)
static Value	intArray(int[] value)
static Value	intValue(int value)
static boolean	isArrayValue(Value value)
static boolean	isBooleanValue(Object value)
static boolean	isNumberValue(Object value)
static boolean	isTextValue(Object value)
static Value	longArray(long[] value)
static Value	longValue(long value)
static Value	numberValue(Number number)
static Value	of(Object value) Generic value factory method.
static Value	of(Object value, boolean allowNull)
static Value	shortArray(short[] value)
static Value	shortValue(short value)
static Value	stringArray(String[] value)
static Value	stringOrNoValue(String value)
static TextValue	stringValue(String value)
static Value[]	values(Object... objects) Generic value factory method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_NUMBER

public static final Value MIN_NUMBER

MAX_NUMBER

public static final Value MAX_NUMBER

MIN_STRING

public static final Value MIN_STRING

MAX_STRING

public static final Value MAX_STRING

COMPARATOR

public static final Comparator<Value> COMPARATOR

Default value comparator. Will correctly compare all storable values and order the value groups according the to comparability group.

NO_VALUE

public static final Value NO_VALUE

Method Detail

isNumberValue

public static boolean isNumberValue(Object value)

isBooleanValue

public static boolean isBooleanValue(Object value)

isTextValue

public static boolean isTextValue(Object value)

isArrayValue

public static boolean isArrayValue(Value value)

coerceToDouble

public static double coerceToDouble(Value value)

stringValue

public static TextValue stringValue(String value)

stringOrNoValue

public static Value stringOrNoValue(String value)

numberValue

public static Value numberValue(Number number)

longValue

public static Value longValue(long value)

intValue

public static Value intValue(int value)

shortValue

public static Value shortValue(short value)

byteValue

public static Value byteValue(byte value)

booleanValue

public static Value booleanValue(boolean value)

charValue

public static Value charValue(char value)

doubleValue

public static Value doubleValue(double value)

floatValue

public static Value floatValue(float value)

stringArray

public static Value stringArray(String[] value)

byteArray

public static Value byteArray(byte[] value)

longArray

public static Value longArray(long[] value)

intArray

public static Value intArray(int[] value)

doubleArray

public static Value doubleArray(double[] value)

floatArray

public static Value floatArray(float[] value)

booleanArray

public static Value booleanArray(boolean[] value)

charArray

public static Value charArray(char[] value)

shortArray

public static Value shortArray(short[] value)

of

public static Value of(Object value)

Generic value factory method.

Beware, this method is intended for converting externally supplied values to the internal Value type, and to make testing convenient. Passing a Value as in parameter should never be needed, and will throw an UnsupportedOperationException.

This method does defensive copying of arrays, while the explicit *Array() factory methods do not.

Parameters:

value - Object to convert to Value

Returns:

the created Value

of

public static Value of(Object value,
                       boolean allowNull)

values

public static Value[] values(Object... objects)

Generic value factory method.

Converts an array of object values to the internal Value type. See of(java.lang.Object).

asObject

@Deprecated
public static Object asObject(Value value)

Deprecated.

asObjects

public static Object[] asObjects(Value[] propertyValues)