Package org.neo4j.ogm.annotation.typeconversion

Annotation Interface Convert

@Retention(RUNTIME) @Target(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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Convert.Unset
    Placeholder to allow the annotation to be applied without specifying an explicit converter implementation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    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 Summary

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

  • Field Details

  • Element Details

    • value

      Class<?> value
      The type of AttributeConverter implementation to use on this property.
      Default:
      org.neo4j.ogm.annotation.typeconversion.Convert.Unset.class

    • graphPropertyType

      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