EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Default Conversions and Converters/Convert

EclipseLink JPA

• EclipseLink Destinations:
• Documentation
• FAQ
• Examples
• Development

Key API

• @Convert
• SerializedObjectConverter

@Convert

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.

@Convert Annotation Attributes

Attribute	Description	Default	Required?
value	The String name for your converter.	"none" String	No

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

Example: @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;
     }
     ...
 }

Version: 2.2.0 DRAFT
Other versions...

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