org.hibernate.testing.orm.junit.RequiresDialect Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-testing-jakarta Show documentation

Support for testing Hibernate ORM Jakarta functionality

There is a newer version: 5.6.15.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.testing.orm.junit;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.hibernate.dialect.Dialect;

import org.junit.jupiter.api.extension.ExtendWith;

/**
 * Indicates that the annotated test class/method should only
 * be run when the indicated Dialect is being used.
 *
 * @author Steve Ebersole
 */
@Inherited
@Retention( RetentionPolicy.RUNTIME )
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Repeatable( RequiresDialects.class )

@ExtendWith( DialectFilterExtension.class )
public @interface RequiresDialect {
	/**
	 * The Dialect class to match.
	 */
	Class value();

	/**
	 * Should subtypes of {@link #value()} be matched?
	 */
	boolean matchSubTypes() default true;

	/**
	 * Comment describing the reason why the dialect is required.
	 *
	 * @return The comment
	 */
	String comment() default "";
}