Revision as of 13:53, 18 June 2010

@Convert Annotation and <convert> XML

The @Convert annotation specifies that a named converter should be used with the corresponding mapped attribute.

 @Target({METHOD, FIELD})
 @Retention(RUNTIME)
 public @interface Convert {
    String value() default "none";
 }

The @Convert has the following reserved names:

• serialized – places the org.eclipse.persistence.mappings.converters.SerializedObjectConverter on the associated mapping.
• none – does not place a converter on the associated mapping.

This example shows how to use the @Convert annotation to define the Employee field gender.

Usage of the @Convert Annotation

 @Entity
 @Table(name="EMPLOYEE")
 @Converter(
     name="genderConverter",
         converterClass=org.myorg.converters.GenderConverter.class
 )
 public class Employee implements Serializable{
     ...
     @Basic
     @Convert("genderConverter")
     public String getGender() {
         return gender;
     }
     ...
 }

Struct Converter	Default Conversions and Converters	Lazy Basics
EclipseLink Home JPA User Guide: Table of Contents, Search
How to contribute to this guide...