Package com.tngtech.archunit.core.domain

Class JavaClasses

java.lang.Object

com.tngtech.archunit.base.ForwardingCollection<JavaClass>

com.tngtech.archunit.core.domain.JavaClasses

All Implemented Interfaces:

DescribedIterable<JavaClass>, HasDescription, CanOverrideDescription<JavaClasses>, Iterable<JavaClass>, Collection<JavaClass>

public final class JavaClasses
extends ForwardingCollection<JavaClass>
implements DescribedIterable<JavaClass>, CanOverrideDescription<JavaClasses>

Nested Class Summary

Nested classes/interfaces inherited from interface com.tngtech.archunit.base.DescribedIterable

DescribedIterable.From

Method Summary

Modifier and Type	Method	Description
JavaClasses	as(String description)	Allows to adjust the description of this object.
boolean	contain(Class<?> reflectedType)
boolean	contain(String typeName)
boolean	containPackage(String packageName)
protected Collection<JavaClass>	delegate()
boolean	equals(Object obj)
JavaClass	get(Class<?> reflectedType)
JavaClass	get(String typeName)
JavaPackage	getDefaultPackage()
String	getDescription()
JavaPackage	getPackage(String packageName)
int	hashCode()
JavaClasses	that(DescribedPredicate<? super JavaClass> predicate)
String	toString()

Methods inherited from class com.tngtech.archunit.base.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Details

that

@PublicAPI(usage=ACCESS)
public JavaClasses that(DescribedPredicate<? super JavaClass> predicate)

Parameters:

predicate - a DescribedPredicate to determine which classes match

Returns:

JavaClasses matching the given predicate; the description will be adjusted according to the predicate's description

as

public JavaClasses as(String description)

Description copied from interface: CanOverrideDescription

Allows to adjust the description of this object. Note that this method will not modify the current object, but instead return a new object with adjusted description.

Specified by:

as in interface CanOverrideDescription<JavaClasses>

Parameters:

description - The description the result of this method will hold

Returns:

A new equivalent object with adjusted description

getDescription

public String getDescription()

Specified by:

getDescription in interface HasDescription

toString

public String toString()

Overrides:

toString in class ForwardingCollection<JavaClass>

contain

@PublicAPI(usage=ACCESS)
public boolean contain(Class<?> reflectedType)

Parameters:

reflectedType - a Java Class object

Returns:

true, if an equivalent JavaClass is contained, false otherwise

See Also:

• get(Class)
• contain(String)

get

@PublicAPI(usage=ACCESS)
public JavaClass get(Class<?> reflectedType)

Parameters:

reflectedType - a Java Class object

Returns:

a JavaClass equivalent to the given type; throws an exception if there is no equivalent class

See Also:

• contain(Class)
• get(String)

contain

@PublicAPI(usage=ACCESS)
public boolean contain(String typeName)

Parameters:

typeName - a fully qualified name of a Java class

Returns:

true, if a JavaClass with the given name is contained, false otherwise

See Also:

• get(String)
• contain(Class)

get

@PublicAPI(usage=ACCESS)
public JavaClass get(String typeName)

Parameters:

typeName - a fully qualified name of a Java class

Returns:

a JavaClass with the given name; throws an exception if there is no class with the given name

See Also:

• contain(Class)
• get(Class)

containPackage

@PublicAPI(usage=ACCESS)
public boolean containPackage(String packageName)

Parameters:

packageName - name of a package, may consist of several parts, e.g. com.myapp.some.subpackage

Returns:

true, if some package with this name is contained, false otherwise

getPackage

@PublicAPI(usage=ACCESS)
public JavaPackage getPackage(String packageName)

Parameters:

packageName - name of a package, may consist of several parts, e.g. com.myapp.some.subpackage

Returns:

the package with the given name; throws an exception if the package does not exist

See Also:

• containPackage(String)

getDefaultPackage

@PublicAPI(usage=ACCESS)
public JavaPackage getDefaultPackage()

Returns:

the default package, i.e. the root of all packages. The default package name ist the empty string.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<JavaClass>

Overrides:

hashCode in class ForwardingCollection<JavaClass>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<JavaClass>

Overrides:

equals in class ForwardingCollection<JavaClass>

delegate

protected Collection<JavaClass> delegate()

Specified by:

delegate in class ForwardingCollection<JavaClass>