com.tngtech.archunit.junit.ArchIgnore Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 TNG Technology Consulting GmbH
 *
 * 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 com.tngtech.archunit.junit;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Marks rules (annotated with @ArchTest) to be ignored by the test support.
 * I.e. rules marked this way will be skipped during evaluation.
 */
@Target({TYPE, FIELD, METHOD})
@Retention(RUNTIME)
public @interface ArchIgnore {
    /**
     * @return why the test is ignored
     */
    String reason() default "";
}