Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Default Conversions and Converters/Convert"
< EclipseLink | UserGuide | JPA | Basic JPA Development | Mapping | Basic Mappings | Default Conversions and Converters
m (→@Convert Annotation) |
m |
||
Line 1: | Line 1: | ||
− | {{EclipseLink_API | + | {{EclipseLink_UserGuide}} |
+ | <!--{{EclipseLink_API | ||
|1=*[http://www.eclipse.org/eclipselink/api/ org.eclipse.persistence.mappings.converters.SerializedObjectConverter] | |1=*[http://www.eclipse.org/eclipselink/api/ org.eclipse.persistence.mappings.converters.SerializedObjectConverter] | ||
− | }} | + | }}--> |
=@Convert Annotation and <convert> XML = | =@Convert Annotation and <convert> XML = | ||
The <tt>@Convert</tt> annotation specifies that a named converter should be used with the corresponding mapped attribute. | The <tt>@Convert</tt> annotation specifies that a named converter should be used with the corresponding mapped attribute. |
Revision as of 13:49, 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 table lists attributes of the @Convert annotation.
Attributes of the @Convert Annotation
Attribute | Description | Default | Required or Optional |
---|---|---|---|
value |
Set this attribute to the String name for your converter. |
"none" String |
optional |
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; } ... }