Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface TypeConverter

@Target({TYPE,METHOD,FIELD}) @Retention(RUNTIME) @Repeatable(TypeConverters.class) public @interface TypeConverter
The TypeConverter annotation is used to specify an EclipseLink TypeConversionConverter for modification of the data value(s) during the reading and writing of a mapped attribute.

A TypeConverter must be uniquely identified by name and can be defined at the class, field and property level and can be specified within an Entity, MappedSuperclass and Embeddable class.

The usage of an TypeConverter is always specified via the Convert annotation and is supported on a Basic, or ElementCollection mapping.

See Also:
Author:
Guy Pelletier

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Name this converter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>
    dataType
    Specify the type stored on the database.
    Class<?>
    objectType
    Specify the type stored on the entity.

  • Element Details

    • name

      String name
      Name this converter. The name should be unique across the whole persistence unit.

    • dataType

      Class<?> dataType
      Specify the type stored on the database.

      The default is inferred from the type of the persistence field or property.

      Default:
      void.class

    • objectType

      Class<?> objectType
      Specify the type stored on the entity.

      The default is inferred from the type of the persistent field or property.

      Default:
      void.class