Package com.tngtech.archunit.core.importer

Interface ImportOption

All Known Implementing Classes:

ImportOption.DoNotIncludeArchives, ImportOption.DoNotIncludeJars, ImportOption.DoNotIncludeTests, ImportOption.DontIncludeArchives, ImportOption.DontIncludeJars, ImportOption.DontIncludeTests, ImportOption.Predefined

@PublicAPI(usage=INHERITANCE)
public interface ImportOption

Will be evaluated for every class location, to determine if the class should be imported.

IMPORTANT: For things like caching to work, it's important that the behavior of any implementation is constant, i.e. throughout the whole run of a test suite, for any Location x, the result of importOption.includes(x) must return the same value on consecutive calls for EVERY instance of the custom implementation of ImportOption.
In other words, if you for example create a custom implementation of ImportOption, where you look at some test specific file, if a certain class should be imported, this will cause wrong caching (i.e. the second run will assume, the classes are already cached, because it can't be determined that the ImportOption would choose different classes to be selected for this run)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ImportOption.DoNotIncludeArchives
static class	ImportOption.DoNotIncludeJars
static class	ImportOption.DoNotIncludeTests	NOTE: This excludes all class files residing in some directory ../target/test-classes/.., ../build/classes/test/..
static class	ImportOption.DontIncludeArchives	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeArchives
static class	ImportOption.DontIncludeJars	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeJars
static class	ImportOption.DontIncludeTests	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeTests
static class	ImportOption.Predefined

Method Summary

Modifier and Type	Method	Description
boolean	includes(Location location)

Method Detail

includes

boolean includes(Location location)