001/**
002 * Powerunit - A JDK1.8 test framework
003 * Copyright (C) 2014 Mathieu Boretti.
004 *
005 * This file is part of Powerunit
006 *
007 * Powerunit is free software: you can redistribute it and/or modify
008 * it under the terms of the GNU General Public License as published by
009 * the Free Software Foundation, either version 3 of the License, or
010 * (at your option) any later version.
011 *
012 * Powerunit is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
015 * GNU General Public License for more details.
016 *
017 * You should have received a copy of the GNU General Public License
018 * along with Powerunit. If not, see <http://www.gnu.org/licenses/>.
019 */
020package ch.powerunit;
021
022import java.lang.annotation.Documented;
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * Used to indicate a test to be ignored.
030 * <p>
031 * This can be used on a class (to ignore completely the class) or on a method
032 * (to ignore only the method).
033 * <p>
034 * Depending on the context, the action is not exactly the same :
035 * <ul>
036 * <li><b>Usage on class</b>
037 * <p>
038 * In this case, no check on the class are done. A single pseudo test execution
039 * will be done, with a skipped status.</li>
040 * <li><b>Usage on method</b>
041 * <p>
042 * In this case, test rule related of this method are not executed.</li>
043 * </ul>
044 *
045 * @author borettim
046 *
047 */
048@Documented
049@Retention(RetentionPolicy.RUNTIME)
050@Target({ ElementType.TYPE, ElementType.METHOD })
051public @interface Ignore {
052}