Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface Convert

@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface Convert
The Convert annotation specifies that a named converter should be used with the corresponding mapped attribute. The Convert annotation has the following reserved names:
  • "serialized": Uses a SerializedObjectConverter on the associated mapping. When using a SerializedObjectConverter the database representation is a binary field holding a serialized version of the object and the object-model representation is a the actual object.
  • "class-instance": Uses an ClassInstanceConverter on the associated mapping. When using a ClassInstanceConverter the database representation is a String representing the Class name and the object-model representation is an instance of that class built with a no-args constructor.
  • "xml": Uses an SerializedObjectConverter with the XMLSerializer on the associated mapping. When using a XMLSerializer the database representation is a character field holding a serialized version of the object and the object-model representation is a the actual object.
  • "json": Uses an SerializedObjectConverter with the JSONSerializer on the associated mapping. When using a JSONSerializer the database representation is a character field holding a serialized version of the object and the object-model representation is a the actual object.
  • "kryo": Uses an SerializedObjectConverter with the org.eclipse.persistence.sessions.serializers.kryo.KryoSerializer on the associated mapping. When using a org.eclipse.persistence.sessions.serializers.kryo.KryoSerializer the database representation is a binary field holding a serialized version of the object and the object-model representation is a the actual object.
  • "none": Places no converter on the associated mapping. This can be used to override a situation where either another converter is defaulted or another converter is set.

When these reserved converters are not used, it is necessary to define a converter to use using the Converter annotation.

See Also:
Author:
Guy Pelletier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    The name of the converter to be used.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLASS_INSTANCE
    Constant name for the reserved class instance converter.
    static final String
    JSON
    Constant name for the reserved JSON converter.
    static final String
    KRYO
    Constant name for the reserved Kryo converter.
    static final String
    NONE
    Constant name for no converter.
    static final String
    SERIALIZED
    Constant name for the reserved Java serialization converter.
    static final String
    XML
    Constant name for the reserved XML converter.

  • Field Details

    • SERIALIZED

      static final String SERIALIZED
      Constant name for the reserved Java serialization converter. This will use Java Serialization to convert the object to and from a binary format.
      See Also:

    • CLASS_INSTANCE

      static final String CLASS_INSTANCE
      Constant name for the reserved class instance converter. This will store the object's class name, and create a new instance of the class on read.
      See Also:

    • XML

      static final String XML
      Constant name for the reserved XML converter. This will use XML Binding runtime to convert the object to and from XML.
      See Also:

    • JSON

      static final String JSON
      Constant name for the reserved JSON converter. This will use EclipseLink Moxy runtime to convert the object to and from JSON.
      See Also:

    • KRYO

      static final String KRYO
      Constant name for the reserved Kryo converter. This will use Kryo to convert the object to and from an optimized binary format.
      See Also:

    • NONE

      static final String NONE
      Constant name for no converter.
      See Also:

  • Element Details

    • value

      String value
      The name of the converter to be used.
      Default:
      "none"