org.eclipse.persistence.annotations

Annotation Type Converter

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=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 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:

Convert

Author:

Guy Pelletier

Since:

Oracle TopLink 11.1.1.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class	converterClass (Required) The converter class to be used.
String	name (Required) Name this converter.

Element Detail

name

public abstract String name

(Required) Name this converter. The name should be unique across the whole persistence unit.

converterClass

public abstract Class converterClass

(Required) The converter class to be used. This class must implement the org.eclipse.persistence.mappings.converters.Converter interface.