com.tngtech.archunit.junit.AnalyzeClasses 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 com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.core.importer.ImportOption;
import com.tngtech.archunit.core.importer.ImportOption.DontIncludeJars;
import com.tngtech.archunit.core.importer.ImportOption.DontIncludeTests;
import com.tngtech.archunit.core.importer.ImportOptions;

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

/**
 * Specifies which packages/locations should be scanned and tested when running a test with the {@link ArchUnitRunner}.
 * 


 * To ignore certain classes (e.g. classes in test scope) see {@link #importOptions()}, in particular {@link DontIncludeTests} and
 * {@link DontIncludeJars}.
 *
 * @see ArchUnitRunner
 */
@Target(TYPE)
@Retention(RUNTIME)
public @interface AnalyzeClasses {
    /**
     * @return Packages to look for in all URLs known to the actual {@link java.net.URLClassLoader}
     */
    String[] packages() default {};

    /**
     * @return Classes that specify packages to look for in all URLs known to the actual {@link java.net.URLClassLoader}
     */
    Class[] packagesOf() default {};

    /**
     * @return Implementations of {@link LocationProvider}. Allows to completely customize the sources,
     * where classes are imported from.
     */
    Class[] locations() default {};

    /**
     * Allows to filter the class import. The supplied types will be instantiated and used to create the
     * {@link ImportOptions} passed to the {@link ClassFileImporter}. Considering caching, compare the notes on
     * {@link ImportOption}.
     *
     * @return The types of {@link ImportOption} to use for the import
     */
    Class[] importOptions() default {};

    /**
     * Controls when the {@link ArchUnitRunner} clears the {@link ClassCache}.
     *
     * @return The {@link CacheMode} to use for this test class.
     */
    CacheMode cacheMode() default CacheMode.FOREVER;
}