Spring Framework example source code file (TestExecutionListeners.java)

This example Spring Framework source code file (TestExecutionListeners.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Spring Framework tags/keywords

annotation, class, class, documented, documented, inherited, inherited, testexecutionlistener, testexecutionlistener, testexecutionlisteners

The Spring Framework TestExecutionListeners.java source code

/*
 * Copyright 2002-2007 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
 *
 *      http://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.context;

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;

/**
 * TestExecutionListeners defines class-level metadata for configuring which
 * {@link TestExecutionListener TestExecutionListeners} should be registered
 * with a {@link TestContextManager}. Typically,
 * {@link TestExecutionListeners @TestExecutionListeners} will be used in
 * conjunction with {@link ContextConfiguration @ContextConfiguration}.
 *
 * @author Sam Brannen
 * @since 2.5
 * @see TestExecutionListener
 * @see TestContextManager
 * @see ContextConfiguration
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@Documented
public @interface TestExecutionListeners {

	/**
	 * <p>
	 * The {@link TestExecutionListener TestExecutionListeners} to register with
	 * a {@link TestContextManager}.
	 * </p>
	 *
	 * @see org.springframework.test.context.support.DependencyInjectionTestExecutionListener
	 * @see org.springframework.test.context.support.DirtiesContextTestExecutionListener
	 * @see org.springframework.test.context.transaction.TransactionalTestExecutionListener
	 */
	Class<? extends TestExecutionListener>[] value();

	/**
	 * <p>
	 * Whether or not {@link #value() TestExecutionListeners} from superclasses
	 * should be <em>inherited.
	 * </p>
	 * <p>
	 * The default value is <code>true, which means that an annotated
	 * class will <em>inherit the listeners defined by an annotated
	 * superclass. Specifically, the listeners for an annotated class will be
	 * appended to the list of listeners defined by an annotated superclass.
	 * Thus, subclasses have the option of <em>extending the list of
	 * listeners. In the following example, <code>AbstractBaseTest will
	 * be configured with <code>DependencyInjectionTestExecutionListener
	 * and <code>DirtiesContextTestExecutionListener; whereas,
	 * <code>TransactionalTest will be configured with
	 * <code>DependencyInjectionTestExecutionListener,
	 * <code>DirtiesContextTestExecutionListener, and
	 * <code>TransactionalTestExecutionListener, in that order.
	 * </p>
	 *
	 * <pre class="code">
	 * {@link TestExecutionListeners @TestExecutionListeners}({ DependencyInjectionTestExecutionListener.class,
	 *     DirtiesContextTestExecutionListener.class })
	 * public abstract class AbstractBaseTest {
	 *     // ...
	 * }
	 *
	 * {@link TestExecutionListeners @TestExecutionListeners}({ TransactionalTestExecutionListener.class })
	 * public class TransactionalTest extends BaseTest {
	 *     // ...
	 * }
	 * </pre>
	 *
	 * <p>
	 * If <code>inheritListeners is set to false, the
	 * listeners for the annotated class will <em>shadow and effectively
	 * replace any listeners defined by a superclass.
	 * </p>
	 */
	boolean inheritListeners() default true;

}