001/*
002 * ModeShape (http://www.modeshape.org)
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 *       http://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.modeshape.common.junit;
018
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Marker annotation used together with the {@link SkipTestRule} JUnit rule, that allows long running tests to be excluded
026 * from the build, using the {@code skipLongRunningTests} system property.
027 *
028 * @author Horia Chiorean (hchiorea@redhat.com)
029 */
030@Retention( RetentionPolicy.RUNTIME)
031@Target( {ElementType.METHOD, ElementType.TYPE})
032public @interface SkipLongRunning {
033
034    String SKIP_LONG_RUNNING_PROPERTY = "skipLongRunningTests";
035
036    /**
037     * The optional reason why the test is skipped.
038     * @return the reason why the test is skipped
039     */
040    String value() default "";
041}