001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.test.annotation;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Test-specific annotation to indicate that a test method has to finish
027 * execution in a {@linkplain #millis() specified time period}.
028 *
029 * <p>If the text execution takes longer than the specified time period, then
030 * the test is considered to have failed.
031 *
032 * <p>Note that the time period includes execution of the test method itself,
033 * any {@linkplain Repeat repetitions} of the test, and any <em>set up</em> or
034 * <em>tear down</em> of the test fixture.
035 *
036 * <p>As of Spring Framework 4.0, this annotation may be used as a
037 * <em>meta-annotation</em> to create custom <em>composed annotations</em>.
038 *
039 * @author Rod Johnson
040 * @author Sam Brannen
041 * @since 2.0
042 * @see org.springframework.test.annotation.Repeat
043 * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner
044 * @see org.springframework.test.context.junit4.rules.SpringMethodRule
045 * @see org.springframework.test.context.junit4.statements.SpringFailOnTimeout
046 */
047@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
048@Retention(RetentionPolicy.RUNTIME)
049@Documented
050public @interface Timed {
051
052        /**
053         * The maximum amount of time (in milliseconds) that a test execution can
054         * take without being marked as failed due to taking too long.
055         */
056        long millis();
057
058}