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

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation
The newest version!
/*
 * 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
//     06/12/2017-2.7 Lukas Jungmann
//       - 518155: [jpa22] add support for repeatable annotations
package org.eclipse.persistence.annotations;

import java.lang.annotation.Repeatable;
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.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * The ObjectTypeConverter annotation is used to specify a
 * {@linkplain org.eclipse.persistence.mappings.converters.ObjectTypeConverter} that converts a fixed
 * number of database data value(s) to Java object value(s) during the reading
 * and writing of a mapped attribute
 * 
 * An ObjectTypeConverter must 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 ObjectTypeConverter is specified via the {@linkplain Convert} annotation
 * and is supported on a Basic, or ElementCollection mapping.
 *
 * @see Convert
 * @author Guy Pelletier
 * @since Oracle TopLink 11.1.1.0.0
 */
@Target({TYPE, METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(ObjectTypeConverters.class)
public @interface ObjectTypeConverter {
    /**
     * The name of this converter. The name should be unique across the whole persistence unit.
     */
    String name();

    /**
     * Specify the type stored on the database.
     * 

     * The default is inferred from the type of the persistence field or property.
     */
    Class dataType() default void.class;

    /**
     * Specify the type stored on the entity.
     * The default is inferred from the type of the persistent field or property.
     */
    Class objectType() default void.class;

    /**
     * Specify the conversion values to be used with the object converter.
     */
    ConversionValue[] conversionValues();

    /**
     * Specify a default object value. Used for legacy data if the data value is missing.
     */
    String defaultObjectValue() default "";
}