org.springframework.test.annotation.Rollback Maven / Gradle / Ivy
Show all versions of spring-test Show documentation
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.test.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* {@code @Rollback} is a test annotation that is used to indicate whether
* a test-managed transaction should be rolled back after
* the test method has completed.
*
* Consult the class-level Javadoc for
* {@link org.springframework.test.context.transaction.TransactionalTestExecutionListener}
* for an explanation of test-managed transactions.
*
*
When declared as a class-level annotation, {@code @Rollback} defines
* the default rollback semantics for all test methods within the test class
* hierarchy or nested class hierarchy. When declared as a method-level annotation,
* {@code @Rollback} defines rollback semantics for the specific test method,
* potentially overriding class-level default commit or rollback semantics.
*
*
{@code @Commit} can be used as direct replacement for {@code @Rollback(false)}.
*
*
Warning: Declaring {@code @Commit} and {@code @Rollback}
* on the same test method or on the same test class is unsupported and may
* lead to unpredictable results.
*
*
This annotation may be used as a meta-annotation to create
* custom composed annotations. Consult the source code for
* {@link Commit @Commit} for a concrete example.
*
*
As of Spring Framework 5.3, this annotation will be inherited from an
* enclosing test class by default. See
* {@link org.springframework.test.context.NestedTestConfiguration @NestedTestConfiguration}
* for details.
*
* @author Sam Brannen
* @since 2.5
* @see Commit
* @see org.springframework.test.context.transaction.TransactionalTestExecutionListener
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Rollback {
/**
* Whether the test-managed transaction should be rolled back
* after the test method has completed.
*
If {@code true}, the transaction will be rolled back; otherwise,
* the transaction will be committed.
*
Defaults to {@code true}.
*/
boolean value() default true;
}