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 DoubleValue	E
static ArrayValue	EMPTY_BOOLEAN_ARRAY
static ArrayValue	EMPTY_BYTE_ARRAY
static ArrayValue	EMPTY_CHAR_ARRAY
static ArrayValue	EMPTY_DOUBLE_ARRAY
static ArrayValue	EMPTY_FLOAT_ARRAY
static ArrayValue	EMPTY_INT_ARRAY
static ArrayValue	EMPTY_LONG_ARRAY
static ArrayValue	EMPTY_SHORT_ARRAY
static TextValue	EMPTY_STRING
static BooleanValue	FALSE
static Value	MAX_NUMBER
static Value	MAX_STRING
static Value	MIN_NUMBER
static Value	MIN_STRING
static Value	NO_VALUE
static DoubleValue	PI
static BooleanValue	TRUE
static Value	ZERO_FLOAT
static Value	ZERO_INT

Method Summary

Modifier and Type	Method and Description
static Object	asObject(Value value) Deprecated.
static Object[]	asObjects(Value[] propertyValues)
static BooleanArray	booleanArray(boolean[] value)
static BooleanValue	booleanValue(boolean value)
static ByteArray	byteArray(byte[] value)
static ByteValue	byteValue(byte value)
static CharArray	charArray(char[] value)
static CharValue	charValue(char value)
static double	coerceToDouble(Value value)
static org.neo4j.values.storable.DoubleArray	doubleArray(double[] value)
static DoubleValue	doubleValue(double value)
static FloatArray	floatArray(float[] value)
static FloatValue	floatValue(float value)
static IntArray	intArray(int[] value)
static IntValue	intValue(int value)
static boolean	isArrayValue(Value value)
static boolean	isBooleanValue(Object value)
static boolean	isNumberValue(Object value)
static boolean	isTextValue(Object value)
static LongArray	longArray(long[] value)
static LongValue	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 ShortArray	shortArray(short[] value)
static ShortValue	shortValue(short value)
static TextArray	stringArray(String... value)
static Value	stringOrNoValue(String value)
static TextValue	stringValue(String value)
static Value	unsafeOf(Object value, boolean allowNull)
static TextValue	utf8Value(byte[] bytes)
static TextValue	utf8Value(byte[] bytes, int offset, int length)
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

ZERO_FLOAT

public static final Value ZERO_FLOAT

ZERO_INT

public static final Value ZERO_INT

MIN_STRING

public static final Value MIN_STRING

MAX_STRING

public static final Value MAX_STRING

TRUE

public static final BooleanValue TRUE

FALSE

public static final BooleanValue FALSE

EMPTY_STRING

public static final TextValue EMPTY_STRING

E

public static final DoubleValue E

PI

public static final DoubleValue PI

EMPTY_SHORT_ARRAY

public static final ArrayValue EMPTY_SHORT_ARRAY

EMPTY_BOOLEAN_ARRAY

public static final ArrayValue EMPTY_BOOLEAN_ARRAY

EMPTY_BYTE_ARRAY

public static final ArrayValue EMPTY_BYTE_ARRAY

EMPTY_CHAR_ARRAY

public static final ArrayValue EMPTY_CHAR_ARRAY

EMPTY_INT_ARRAY

public static final ArrayValue EMPTY_INT_ARRAY

EMPTY_LONG_ARRAY

public static final ArrayValue EMPTY_LONG_ARRAY

EMPTY_FLOAT_ARRAY

public static final ArrayValue EMPTY_FLOAT_ARRAY

EMPTY_DOUBLE_ARRAY

public static final ArrayValue EMPTY_DOUBLE_ARRAY

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)

utf8Value

public static TextValue utf8Value(byte[] bytes)

utf8Value

public static TextValue utf8Value(byte[] bytes,
                                  int offset,
                                  int length)

stringValue

public static TextValue stringValue(String value)

stringOrNoValue

public static Value stringOrNoValue(String value)

numberValue

public static Value numberValue(Number number)

longValue

public static LongValue longValue(long value)

intValue

public static IntValue intValue(int value)

shortValue

public static ShortValue shortValue(short value)

byteValue

public static ByteValue byteValue(byte value)

booleanValue

public static BooleanValue booleanValue(boolean value)

charValue

public static CharValue charValue(char value)

doubleValue

public static DoubleValue doubleValue(double value)

floatValue

public static FloatValue floatValue(float value)

stringArray

public static TextArray stringArray(String... value)

byteArray

public static ByteArray byteArray(byte[] value)

longArray

public static LongArray longArray(long[] value)

intArray

public static IntArray intArray(int[] value)

doubleArray

public static org.neo4j.values.storable.DoubleArray doubleArray(double[] value)

floatArray

public static FloatArray floatArray(float[] value)

booleanArray

public static BooleanArray booleanArray(boolean[] value)

charArray

public static CharArray charArray(char[] value)

shortArray

public static ShortArray 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)

unsafeOf

public static Value unsafeOf(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)