org.hibernate.annotations.ConverterRegistration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beangle-hibernate-core Show documentation

Hibernate Orm Core Shade,Support Scala Collection

There is a newer version: 6.6.2.Final

Show newest version

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html.
 */
package org.hibernate.annotations;

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

import jakarta.persistence.AttributeConverter;
import jakarta.persistence.Converter;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Registers an {@link jakarta.persistence.AttributeConverter}.  The main
 * purpose is to be able to control {@link jakarta.persistence.Converter#autoApply()}
 * external to the actual converter class, which might be useful for third-parties
 * converters.
 *
 * @author Steve Ebersole
 */
@Target( {TYPE, ANNOTATION_TYPE, PACKAGE} )
@Retention( RUNTIME )
@Repeatable( ConverterRegistrations.class )
public @interface ConverterRegistration {
	/**
	 * The converter class to register
	 */
	Class> converter();

	/**
	 * The domain type to which this converter should be applied.  This allows
	 * refining the domain type associated with the converter e.g. to apply to
	 * a subtype.
	 * 
	 * With {@link #autoApply()} set to true, this will effectively override converters
	 * defined with {@link Converter#autoApply()} set to {@code false} and auto-apply them.
	 * 

	 * With {@link #autoApply()} set to false, this will effectively override converters
	 * defined with {@link Converter#autoApply()} set to {@code true} and disable auto-apply
	 * for them.
	 */
	Class domainType() default void.class;

	/**
	 * Should the registered converter be auto applied for
	 * converting values of its reported domain type?
	 * 
	 * Defaults to true as that is the more common use case for this annotation.
	 */
	boolean autoApply() default true;
}