org.eclipse.persistence.annotations.StructConverter Maven / Gradle / Ivy
/*
* Copyright (c) 1998, 2020 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 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;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* A StructConverter is a special type of converter that handles the conversion of a specific
* database Struct type. This is normally used for extended database types such as spatial geometric types.
*
* A StructConverter is different than a regular attribute Converter, and does not implement the same interface.
* A StructConverter will be used to convert any matching Struct type.
*
* @see org.eclipse.persistence.platform.database.converters.StructConverter
*/
@Target({TYPE, METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(StructConverters.class)
public @interface StructConverter {
/**
* (Required) Name this converter. The name should be unique across the
* whole persistence unit.
*/
String name();
/**
* (Required) The StructConverter class to be used. This class must implement the
* EclipseLink org.eclipse.persistence.platform.database.converters.StructConverter
* interface.
*
* You may also alternatively specify a pre-defined EclipseLink
* org.eclipse.persistence.config.StructConverterType
*
* @see org.eclipse.persistence.platform.database.converters.StructConverter
* @see org.eclipse.persistence.config.StructConverterType
*/
String converter();
}