Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface Converter

@Target({TYPE,METHOD,FIELD}) @Retention(RUNTIME) @Repeatable(Converters.class) public @interface Converter
A Converter is used to customize the values during the reading from the database into the object model as well as during the writing back of changes into the database. This annotation allows developers to define a named converter that can be used in their mappings. A converter can be defined on an entity class, method, or field.

A Converter 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 a Converter 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
    Class<?>
    converterClass
    The converter class to be used.
    String
    name
    The name of this converter.

  • Element Details

    • name

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

    • converterClass

      Class<?> converterClass
      The converter class to be used. This class must implement the Converter interface.