org.neo4j.ogm.annotation.typeconversion

Annotation Type Convert

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Inherited
public @interface Convert

Annotation to be applied to fields of entity properties to specify the AttributeConverter to use for writing or reading its value in the graph database.

Author:

Vince Bickers, Adam George, Michael J. Simons

Field Summary

Fields

Modifier and Type	Fields and Description
static String	CONVERTER
static String	GRAPH_TYPE

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	graphPropertyType The type to which the value of the annotated member should be converted before saving as a property in the graph database.
Class<?>	value The type of AttributeConverter implementation to use on this property.

Field Detail

CONVERTER

public static final String CONVERTER

GRAPH_TYPE

public static final String GRAPH_TYPE

Element Detail

value

public abstract Class<?> value

The type of AttributeConverter implementation to use on this property.

Default:

org.neo4j.ogm.annotation.typeconversion.Convert.Unset.class

graphPropertyType

public abstract Class<?> graphPropertyType

The type to which the value of the annotated member should be converted before saving as a property in the graph database.

This is an optional attribute that should only be needed if value() hasn't been set to an explicit converter, as it only gets used to look up converters that can do the job at runtime.

Default:

org.neo4j.ogm.annotation.typeconversion.Convert.Unset.class