org.eclipse.persistence.annotations.Convert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction f2b9fc5
There is a newer version: 5.0.0-B03
/*
 * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation from Oracle TopLink
//     tware - March 13, 2008 - 1.0M6 - JavaDoc rewrite
package org.eclipse.persistence.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * The Convert annotation specifies that a named converter should be used with
 * the corresponding mapped attribute. The Convert annotation has the following
 * reserved names:
 * 
 *  {@value #SERIALIZED}: Uses a {@linkplain org.eclipse.persistence.mappings.converters.SerializedObjectConverter}
 *  on the associated mapping. When using a {@linkplain org.eclipse.persistence.mappings.converters.SerializedObjectConverter}
 *  the database representation is a binary field holding a serialized version of the object and the object-model representation is a the
 *  actual object.
 *  {@value #CLASS_INSTANCE}: Uses an {@linkplain org.eclipse.persistence.mappings.converters.ClassInstanceConverter}
 *  on the associated mapping. When using a {@linkplain org.eclipse.persistence.mappings.converters.ClassInstanceConverter}
 *  the database representation is a String representing the Class name and the object-model representation is an instance
 *  of that class built with a no-args constructor.
 *  {@value #XML}: Uses an {@linkplain org.eclipse.persistence.mappings.converters.SerializedObjectConverter}
 *  with the {@linkplain org.eclipse.persistence.sessions.serializers.XMLSerializer} on the associated mapping.
 *  When using a {@linkplain org.eclipse.persistence.sessions.serializers.XMLSerializer} the database representation is a
 *  character field holding a serialized version of the object and the object-model representation is a the actual object.
 *  {@value #JSON}: Uses an {@linkplain org.eclipse.persistence.mappings.converters.SerializedObjectConverter}
 *  with the {@linkplain org.eclipse.persistence.sessions.serializers.JSONSerializer} on the associated mapping.
 *  When using a {@linkplain org.eclipse.persistence.sessions.serializers.JSONSerializer} the database representation is a
 *  character field holding a serialized version of the object and the object-model representation is a the actual object.
 *  {@value #KRYO}: Uses an {@linkplain org.eclipse.persistence.mappings.converters.SerializedObjectConverter}
 *  with the org.eclipse.persistence.sessions.serializers.kryo.KryoSerializer on the associated mapping.
 *  When using a org.eclipse.persistence.sessions.serializers.kryo.KryoSerializer the database representation is a
 *  binary field holding a serialized version of the object and the object-model representation is a the actual object.
 *  {@value #NONE}: Places no converter on the associated mapping. This can be used to override a situation where either
 *  another converter is defaulted or another converter is set.
 * 
 * 
 * When these reserved converters are not used, it is necessary to define a converter to use using the {@linkplain Converter} annotation.
 *
 * @see Converter
 * @see ObjectTypeConverter
 * @see TypeConverter
 * @see org.eclipse.persistence.mappings.converters.SerializedObjectConverter
 * @see org.eclipse.persistence.mappings.converters.ClassInstanceConverter
 *
 * @author Guy Pelletier
 * @since Oracle TopLink 11.1.1.0.0
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface Convert {
    /**
     * The name of the converter to be used.
     */
    String value() default NONE;

    /**
     * Constant name for the reserved Java serialization converter.
     * This will use Java Serialization to convert the object to and from a binary format.
     */
    String SERIALIZED = "serialized";

    /**
     * Constant name for the reserved class instance converter.
     * This will store the object's class name, and create a new instance of the class on read.
     */
    String CLASS_INSTANCE = "class-instance";

    /**
     * Constant name for the reserved XML converter.
     * This will use XML Binding runtime to convert the object to and from XML.
     */
    String XML = "xml";

    /**
     * Constant name for the reserved JSON converter.
     * This will use EclipseLink Moxy runtime to convert the object to and from JSON.
     */
    String JSON = "json";

    /**
     * Constant name for the reserved Kryo converter.
     * This will use Kryo to convert the object to and from an optimized binary format.
     */
    String KRYO = "kryo";

    /**
     * Constant name for no converter.
     */
    String NONE = "none";
}