java.lang.Object

com.tngtech.archunit.core.importer.ClassFileImporter

public final class ClassFileImporter
extends java.lang.Object

The central API to import JavaClasses from compiled Java class files. Supports various types of Location, e.g. Path, JarFile or URL. The Locations that are scanned can be filtered by passing any number of ImportOption to withImportOption(ImportOption), which will then be ANDed (compare ImportOptions).

Note that information about a class is only complete, if all necessary classes are imported. For example, if class A is imported, and A accesses class B, but class B is not imported, the import will behave according to the configured ClassResolver. With the default configuration, the importer will use the ClassResolverFromClasspath to attempt to import missing classes from the classpath, and by that complete any information necessary for rules. In the above case this would mean, if class A accesses B, but B is missing from the set of imported classes, the importer will try to locate the class on the classpath and then import that class, thus acquiring more information like superclasses and interfaces. However, it will not transitively go on to resolve access targets of these classes.

The resolution behavior, i.e. what the importer does if a class is missing from the context, can be configured by providing a respective ClassResolver. To use the simplest ClassResolver possible, namely one that does not import any further classes, simply configure

"resolveMissingDependenciesFromClassPath"=false

within your "archunit.properties".
Whenever the configured ClassResolver does not import a class, the importer will simply create a stub with all information known from the access, i.e. the fully qualified name of B and not much more. In particular the stub class B will miss any information like super classes, interfaces, etc.

In short, if one wants to write rules about certain properties of classes, it is important to ensure that all relevant classes are imported, even if those might be classes from the JDK (like RuntimeException or Exception).

For further information consult the ArchUnit user guide.

See Also:: ArchConfiguration

Constructor Summary

Constructors

Constructor Description

ClassFileImporter()

ClassFileImporter(ImportOptions importOptions)

Method Summary

Modifier and Type	Method	Description
`JavaClass`	`importClass(java.lang.Class<?> clazz)`	Delegates to `importClasses(Collection)`
`JavaClasses`	`importClasses(java.lang.Class<?>... classes)`	Delegates to `importClasses(Collection)`
`JavaClasses`	`importClasses(java.util.Collection<java.lang.Class<?>> classes)`	Imports the class files of the supplied classes from the classpath / modulepath.
`JavaClasses`	`importClasspath()`	Imports classes from the whole classpath without archives (JARs or JRTs).
`JavaClasses`	`importClasspath(ImportOptions options)`	Imports classes from the whole classpath considering the supplied `ImportOptions`. Note that ArchUnit does not distinguish between the classpath and the modulepath for Java >= 9, thus all classes from the classpath or the modulepath will be considered.
`JavaClasses`	`importJar(java.util.jar.JarFile jar)`	For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to `ClassFileImporter`.
`JavaClasses`	`importJars(java.lang.Iterable<java.util.jar.JarFile> jarFiles)`	Imports all Java class files in the given `JAR files`.
`JavaClasses`	`importJars(java.util.jar.JarFile... jarFiles)`	Delegates to `importJars(Iterable)`
`JavaClasses`	`importLocations(java.util.Collection<Location> locations)`	Imports all class files at the given `locations`.
`JavaClasses`	`importPackages(java.lang.String... packages)`	Imports packages via `Locations.ofPackage(String)` For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to `ClassFileImporter`.
`JavaClasses`	`importPackages(java.util.Collection<java.lang.String> packages)`	Imports packages via `Locations.ofPackage(String)` For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to `ClassFileImporter`.
`JavaClasses`	`importPackagesOf(java.lang.Class<?>... classes)`	Delegates to `importPackagesOf(Collection)`
`JavaClasses`	`importPackagesOf(java.util.Collection<java.lang.Class<?>> classes)`	Takes the packages of the supplied classes and delegates to `importPackages(String...)`
`JavaClasses`	`importPath(java.lang.String path)`	Converts the given `String` to a `Path` and delegates to `importPaths(Collection)`.
`JavaClasses`	`importPath(java.nio.file.Path path)`	Delegates to `importPaths(Collection)`
`JavaClasses`	`importPaths(java.lang.String... paths)`	Converts the given `Strings` to `Paths` and delegates to `importPaths(Collection)`.
`JavaClasses`	`importPaths(java.nio.file.Path... paths)`	Delegates to `importPaths(Collection)`
`JavaClasses`	`importPaths(java.util.Collection<java.nio.file.Path> paths)`	Imports all class files at the given `file paths`.
`JavaClasses`	`importUrl(java.net.URL url)`	Converts the supplied `URL` to `Location` and delegates to `importLocations(Collection)`
`JavaClasses`	`importUrls(java.util.Collection<java.net.URL> urls)`	Converts the supplied `URLs` to `locations` and delegates to `importLocations(Collection)`
`ClassFileImporter`	`withImportOption(ImportOption option)`	Allows filtering the class files to import by their `Location` (i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ClassFileImporter
  
  @PublicAPI(usage=ACCESS) public ClassFileImporter()
- ClassFileImporter
  
  @PublicAPI(usage=ACCESS) public ClassFileImporter(ImportOptions importOptions)
Method Details
- withImportOption
  
  @PublicAPI(usage=ACCESS) public ClassFileImporter withImportOption(ImportOption option)
  
  Allows filtering the class files to import by their Location (i.e. URI). Note that this object will not be modified, but instead a copy with adjusted behavior will be returned.
  
  Parameters:
  
  option - Defines which class file Location to import
  
  Returns:
  
  A ClassFileImporter which filters the specified class file URIs
- importPath
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPath(java.lang.String path)
  
  Converts the given String to a Path and delegates to importPaths(Collection).
- importPath
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPath(java.nio.file.Path path)
  
  Delegates to importPaths(Collection)
- importPaths
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPaths(java.lang.String... paths)
  
  Converts the given Strings to Paths and delegates to importPaths(Collection).
- importPaths
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPaths(java.nio.file.Path... paths)
  
  Delegates to importPaths(Collection)
- importPaths
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPaths(java.util.Collection<java.nio.file.Path> paths)
  
  Imports all class files at the given file paths. If a Path refers to a single class file, that file is imported. If a path refers to a directory, all class files from that directory as well as sub directories will be imported.
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importJar
  
  @PublicAPI(usage=ACCESS) public JavaClasses importJar(java.util.jar.JarFile jar)
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importJars
  
  @PublicAPI(usage=ACCESS) public JavaClasses importJars(java.util.jar.JarFile... jarFiles)
  
  Delegates to importJars(Iterable)
- importJars
  
  @PublicAPI(usage=ACCESS) public JavaClasses importJars(java.lang.Iterable<java.util.jar.JarFile> jarFiles)
  Imports all Java class files in the given JAR files. To import just parts of JAR archives, it is possible to refer to those classes by URL (compare importLocations(Collection)).
  For example to import the folder /com/my/subfolder within /path/to/some.jar it is possible to use the URL
  jar:file:///path/to/some.jar!/com/my/subfolder
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importPackages
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPackages(java.util.Collection<java.lang.String> packages)
  
  Imports packages via Locations.ofPackage(String)
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importPackages
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPackages(java.lang.String... packages)
  
  Imports packages via Locations.ofPackage(String)
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importPackagesOf
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPackagesOf(java.lang.Class<?>... classes)
  
  Delegates to importPackagesOf(Collection)
- importPackagesOf
  
  @PublicAPI(usage=ACCESS) public JavaClasses importPackagesOf(java.util.Collection<java.lang.Class<?>> classes)
  
  Takes the packages of the supplied classes and delegates to importPackages(String...)
- importClasspath
  
  @PublicAPI(usage=ACCESS) public JavaClasses importClasspath()
  
  Imports classes from the whole classpath without archives (JARs or JRTs).
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importClasspath
  
  @PublicAPI(usage=ACCESS) public JavaClasses importClasspath(ImportOptions options)
  
  Imports classes from the whole classpath considering the supplied ImportOptions.
  Note that ArchUnit does not distinguish between the classpath and the modulepath for Java >= 9, thus all classes from the classpath or the modulepath will be considered.
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importClass
  
  @PublicAPI(usage=ACCESS) public JavaClass importClass(java.lang.Class<?> clazz)
  
  Delegates to importClasses(Collection)
- importClasses
  
  @PublicAPI(usage=ACCESS) public JavaClasses importClasses(java.lang.Class<?>... classes)
  
  Delegates to importClasses(Collection)
- importClasses
  
  @PublicAPI(usage=ACCESS) public JavaClasses importClasses(java.util.Collection<java.lang.Class<?>> classes)
  
  Imports the class files of the supplied classes from the classpath / modulepath.
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.
- importUrl
  
  @PublicAPI(usage=ACCESS) public JavaClasses importUrl(java.net.URL url)
  
  Converts the supplied URL to Location and delegates to importLocations(Collection)
- importUrls
  
  @PublicAPI(usage=ACCESS) public JavaClasses importUrls(java.util.Collection<java.net.URL> urls)
  
  Converts the supplied URLs to locations and delegates to importLocations(Collection)
- importLocations
  
  @PublicAPI(usage=ACCESS) public JavaClasses importLocations(java.util.Collection<Location> locations)
  Imports all class files at the given locations. The behavior will depend on the type of Location, i.e. the target of the underlying URI:
  
  a single class file =< that file will be imported
  
  a directory =< all class files from that directory as well as sub directories will be imported
  
  a JAR file =< all class files from that archive will be imported
  
  a JAR URI representing a class (e.g. 'jar:file:///some.jar!/some/MyClass.class') =< that file will be imported
  
  a JAR URI representing a folder (e.g. 'jar:file:///some.jar!/some/pkg') =< all class files from that folder as well as sub folders within the JAR archive will be imported
  
  For information about the impact of the imported classes on the evaluation of rules, as well as configuration and details, refer to ClassFileImporter.

Constructor	Description
`ClassFileImporter()`
`ClassFileImporter(ImportOptions importOptions)`

Class ClassFileImporter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

ClassFileImporter

ClassFileImporter

Method Details

withImportOption

importPath

importPath

importPaths

importPaths

importPaths

importJar

importJars

importJars

importPackages

importPackages

importPackagesOf

importPackagesOf

importClasspath

importClasspath

importClass

importClasses

importClasses

importUrl

importUrls

importLocations