Package com.tngtech.archunit.core.importer

Class Location

java.lang.Object

com.tngtech.archunit.core.importer.Location

public abstract class Location
extends Object

Handles various forms of location from where classes can be imported in a consistent way. Any location will be treated like a URI, thus there will not be any platform dependent file separator problems.

Examples for locations could be

• file:///home/someuser/workspace/myproject/target/classes/myproject/Foo.class
• jar:file:///home/someuser/.m2/repository/myproject/foolib.jar!/myproject/Foo.class

Method Summary

Modifier and Type	Method	Description
URI	asURI()
boolean	contains(String part)
boolean	equals(Object obj)
int	hashCode()
abstract boolean	isArchive()	This is a generalization of isJar().
abstract boolean	isJar()
boolean	matches(Pattern pattern)
static Location	of(URI uri)
static Location	of(URL url)
static Location	of(Path path)
static Location	of(JarFile jar)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

asURI

@PublicAPI(usage=ACCESS)
public URI asURI()

contains

@PublicAPI(usage=ACCESS)
public boolean contains(String part)

Parameters:

part - A part to check the respective location URI for

Returns:

true, if the respective URI contains the given part, false otherwise

matches

@PublicAPI(usage=ACCESS)
public boolean matches(Pattern pattern)

Parameters:

pattern - A pattern to compare the respective location URI against

Returns:

true, if the respective URI matches the given pattern, false otherwise

isJar

@PublicAPI(usage=ACCESS)
public abstract boolean isJar()

isArchive

@PublicAPI(usage=ACCESS)
public abstract boolean isArchive()

This is a generalization of isJar(). Before JDK 9, the only archives were Jar files, starting with JDK 9, we also have JRTs (the JDK modules).

Returns:

true, if this location represents an archive, like a JAR or JRT, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

@PublicAPI(usage=ACCESS)
public static Location of(URL url)

of

@PublicAPI(usage=ACCESS)
public static Location of(URI uri)

of

@PublicAPI(usage=ACCESS)
public static Location of(JarFile jar)

of

@PublicAPI(usage=ACCESS)
public static Location of(Path path)