org.eclipse.persistence.annotations

Annotation Type TypeConverter

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface TypeConverter

The TypeConverter annotation is used to specify an EclipseLink org.eclipse.persistence.mappings.converters.TypeConversionConverter for modification of the data value(s) during the reading and writing of a mapped attribute. A TypeConverter 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 an TypeConverter 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
java.lang.String	name (Required) Name this converter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class	dataType (Optional) Specify the type stored on the database.
java.lang.Class	objectType (Optional) Specify the type stored on the entity.

Element Detail

name

public abstract java.lang.String name

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

dataType

public abstract java.lang.Class dataType

(Optional) Specify the type stored on the database. The default is inferred from the type of the persistence field or property.

Default:

void.class

objectType

public abstract java.lang.Class objectType

(Optional) Specify the type stored on the entity. The default is inferred from the type of the persistent field or property.

Default:

void.class