org.eclipse.persistence.annotations

public @Interface SerializedConverter

Annotations

@Target:TYPE, METHOD, FIELD
@Retention:RUNTIME
@Repeatable:SerializedConverters

Imports

java.lang.annotation.Retention, .Target, .Repeatable, org.eclipse.persistence.sessions.serializers.JavaSerializer, .Serializer

A SerializedConverter is used to serialize an object's value into a database binary, character, or XML field. This annotation allows a named converter that can be used in mappings. A converter must be be uniquely identified by name and can be defined at the class level and can be specified within an Entity, MappedSuperclass and Embeddable class. The usage of a SerializedConverter is always specified via the Converter annotation and is supported on a Basic, or ElementCollection mapping.

Author: James Sutherland
Since: EclipseLink 2.6
See Also: org.eclipse.persistence.annotations.Converter, org.eclipse.persistence.sessions.serializers.Serializer

Method Summary

Modifier and Type	Method and Description
public String	name() (Required) Name this converter.
public Class<? extends Serializer>	serializerClass() The serializer class to be used.
public String	serializerPackage() Allows a package name to be passed to the serializer.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

name	back to summary
public String name() (Required) Name this converter. The name should be unique across the whole persistence unit.

serializerClass	back to summary
public Class<? extends Serializer> serializerClass() The serializer class to be used. This class must implement the org.eclipse.persistence.sessions.serializers.Serializer interface.

serializerPackage	back to summary
public String serializerPackage() Allows a package name to be passed to the serializer. This is used by some serializers such as XML, JSON to initialize the JAXB context from the classes in the package or a jaxb.index file.