Package com.tngtech.archunit.core.importer

Class ClassFileImporter

java.lang.Object

com.tngtech.archunit.core.importer.ClassFileImporter

public final class ClassFileImporter
extends java.lang.Object

The central API to import JavaClasses. 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.

Constructor Summary

Constructors

Constructor	Description
ClassFileImporter()
ClassFileImporter(ImportOptions importOptions)

Method Summary

Modifier and Type	Method	Description
JavaClass	importClass(java.lang.Class<?> clazz)
JavaClasses	importClasses(java.lang.Class<?>... classes)
JavaClasses	importClasses(java.util.Collection<java.lang.Class<?>> classes)
JavaClasses	importClasspath()	Imports classes from the whole classpath without archives (JARs or JRTs).
JavaClasses	importClasspath(ImportOptions options)
JavaClasses	importJar(java.util.jar.JarFile jar)
JavaClasses	importJars(java.lang.Iterable<java.util.jar.JarFile> jarFiles)
JavaClasses	importJars(java.util.jar.JarFile... jarFiles)
JavaClasses	importLocations(java.util.Collection<Location> locations)
JavaClasses	importPackages(java.lang.String... packages)	Imports packages via Locations.ofPackage(String)
JavaClasses	importPackages(java.util.Collection<java.lang.String> packages)	Imports packages via Locations.ofPackage(String)
JavaClasses	importPackagesOf(java.lang.Class<?>... classes)
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)
JavaClasses	importPath(java.nio.file.Path path)
JavaClasses	importPaths(java.lang.String... paths)
JavaClasses	importPaths(java.nio.file.Path... paths)
JavaClasses	importPaths(java.util.Collection<java.nio.file.Path> paths)
JavaClasses	importUrl(java.net.URL url)
JavaClasses	importUrls(java.util.Collection<java.net.URL> urls)
ClassFileImporter	withImportOption(ImportOption option)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFileImporter

public ClassFileImporter()

ClassFileImporter

public ClassFileImporter(ImportOptions importOptions)

Method Detail

withImportOption

public ClassFileImporter withImportOption(ImportOption option)

importPath

public JavaClasses importPath(java.lang.String path)

importPath

public JavaClasses importPath(java.nio.file.Path path)

importPaths

public JavaClasses importPaths(java.lang.String... paths)

importPaths

public JavaClasses importPaths(java.nio.file.Path... paths)

importPaths

public JavaClasses importPaths(java.util.Collection<java.nio.file.Path> paths)

importJar

public JavaClasses importJar(java.util.jar.JarFile jar)

importJars

public JavaClasses importJars(java.util.jar.JarFile... jarFiles)

importJars

public JavaClasses importJars(java.lang.Iterable<java.util.jar.JarFile> jarFiles)

importPackages

public JavaClasses importPackages(java.util.Collection<java.lang.String> packages)

Imports packages via Locations.ofPackage(String)

importPackages

public JavaClasses importPackages(java.lang.String... packages)

Imports packages via Locations.ofPackage(String)

importPackagesOf

public JavaClasses importPackagesOf(java.lang.Class<?>... classes)

See Also:

importPackagesOf(Collection)

importPackagesOf

public JavaClasses importPackagesOf(java.util.Collection<java.lang.Class<?>> classes)

Takes the packages of the supplied classes and delegates to importPackages(String...)

importClasspath

public JavaClasses importClasspath()

Imports classes from the whole classpath without archives (JARs or JRTs).

Returns:

Imported classes

importClasspath

public JavaClasses importClasspath(ImportOptions options)

importClass

public JavaClass importClass(java.lang.Class<?> clazz)

importClasses

public JavaClasses importClasses(java.lang.Class<?>... classes)

importClasses

public JavaClasses importClasses(java.util.Collection<java.lang.Class<?>> classes)

importUrl

public JavaClasses importUrl(java.net.URL url)

importUrls

public JavaClasses importUrls(java.util.Collection<java.net.URL> urls)

importLocations

public JavaClasses importLocations(java.util.Collection<Location> locations)