org.eclipse.persistence.annotations

Annotation Type SerializedConverter

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=SerializedConverters.class)
public @interface SerializedConverter

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.

See Also:

Converter, Serializer

Author:

James Sutherland

Since:

EclipseLink 2.6

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<? extends Serializer>	serializerClass The serializer class to be used.
java.lang.String	serializerPackage Allows a package name to be passed to the serializer.

Element Detail

name

public abstract java.lang.String name

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

serializerPackage

public abstract java.lang.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.

Default:

""

serializerClass

public abstract java.lang.Class<? extends Serializer> serializerClass

The serializer class to be used. This class must implement the org.eclipse.persistence.sessions.serializers.Serializer interface.

Default:

org.eclipse.persistence.sessions.serializers.JavaSerializer.class