com.tngtech.archunit.lang.conditions

Class ArchConditions

java.lang.Object

com.tngtech.archunit.lang.conditions.ArchConditions

public final class ArchConditions
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static ArchCondition<JavaClass>	accessClassesThat(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	accessClassesThatResideIn(java.lang.String packageIdentifier)
static ArchCondition<JavaClass>	accessClassesThatResideInAnyPackage(java.lang.String... packageIdentifiers)
static ArchCondition<JavaClass>	accessField(java.lang.Class<?> owner, java.lang.String fieldName)
static ArchCondition<JavaClass>	accessField(java.lang.String ownerName, java.lang.String fieldName)
static ArchCondition<JavaClass>	accessFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)
static ArchCondition<JavaClass>	accessTargetWhere(DescribedPredicate<? super JavaAccess<?>> predicate)
static ArchCondition<JavaClass>	beAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)
static ArchCondition<JavaClass>	beAnnotatedWith(DescribedPredicate<? super JavaAnnotation> predicate)
static ArchCondition<JavaClass>	beAnnotatedWith(java.lang.String typeName)
static ArchCondition<JavaClass>	beAssignableFrom(java.lang.Class<?> type)
static ArchCondition<JavaClass>	beAssignableFrom(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	beAssignableFrom(java.lang.String typeName)
static ArchCondition<JavaClass>	beAssignableTo(java.lang.Class<?> type)
static ArchCondition<JavaClass>	beAssignableTo(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	beAssignableTo(java.lang.String typeName)
static ArchCondition<JavaClass>	beInterfaces()
static ArchCondition<JavaClass>	bePackagePrivate()
static ArchCondition<JavaClass>	bePrivate()
static ArchCondition<JavaClass>	beProtected()
static ArchCondition<JavaClass>	bePublic()
static ArchCondition<JavaClass>	callCodeUnitWhere(DescribedPredicate<? super JavaCall<?>> predicate)
static ArchCondition<JavaClass>	callConstructor(java.lang.Class<?> owner, java.lang.Class<?>... parameterTypes)
static ArchCondition<JavaClass>	callConstructor(java.lang.String ownerName, java.lang.String... parameterTypeNames)
static ArchCondition<JavaClass>	callConstructorWhere(DescribedPredicate<? super JavaConstructorCall> predicate)
static ArchCondition<JavaClass>	callMethod(java.lang.Class<?> owner, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
static ArchCondition<JavaClass>	callMethod(java.lang.String ownerName, java.lang.String methodName, java.lang.String... parameterTypeNames)
static ArchCondition<JavaClass>	callMethodWhere(DescribedPredicate<? super JavaMethodCall> predicate)
static DescribedPredicate<HasName>	fullyQualifiedName(java.lang.String name)
static ArchCondition<JavaClass>	getField(java.lang.Class<?> owner, java.lang.String fieldName)
static ArchCondition<JavaClass>	getField(java.lang.String ownerName, java.lang.String fieldName)
static ArchCondition<JavaClass>	getFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)
static ArchCondition<JavaClass>	haveFullyQualifiedName(java.lang.String name)
static ArchCondition<JavaClass>	haveModifier(JavaModifier modifier)
static ArchCondition<JavaClass>	haveNameMatching(java.lang.String regex)
static ArchCondition<JavaClass>	haveNameNotMatching(java.lang.String regex)
static ArchCondition<JavaClass>	haveSimpleName(java.lang.String name)
static ArchCondition<JavaClass>	haveSimpleNameContaining(java.lang.String infix)
static ArchCondition<JavaClass>	haveSimpleNameEndingWith(java.lang.String suffix)
static ArchCondition<JavaClass>	haveSimpleNameNotContaining(java.lang.String infix)
static ArchCondition<JavaClass>	haveSimpleNameNotEndingWith(java.lang.String suffix)
static ArchCondition<JavaClass>	haveSimpleNameNotStartingWith(java.lang.String prefix)
static ArchCondition<JavaClass>	haveSimpleNameStartingWith(java.lang.String prefix)
static ArchCondition<JavaClass>	implement(java.lang.Class<?> interfaceType)
static ArchCondition<JavaClass>	implement(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	implement(java.lang.String interfaceTypeName)
static <T> ArchCondition<T>	never(ArchCondition<T> condition)
static ArchCondition<JavaClass>	notBeAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)
static ArchCondition<JavaClass>	notBeAnnotatedWith(DescribedPredicate<? super JavaAnnotation> predicate)
static ArchCondition<JavaClass>	notBeAnnotatedWith(java.lang.String typeName)
static ArchCondition<JavaClass>	notBeAssignableFrom(java.lang.Class<?> type)
static ArchCondition<JavaClass>	notBeAssignableFrom(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	notBeAssignableFrom(java.lang.String typeName)
static ArchCondition<JavaClass>	notBeAssignableTo(java.lang.Class<?> type)
static ArchCondition<JavaClass>	notBeAssignableTo(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	notBeAssignableTo(java.lang.String typeName)
static ArchCondition<JavaClass>	notBeInterfaces()
static ArchCondition<JavaClass>	notBePackagePrivate()
static ArchCondition<JavaClass>	notBePrivate()
static ArchCondition<JavaClass>	notBeProtected()
static ArchCondition<JavaClass>	notBePublic()
static ArchCondition<JavaClass>	notHaveFullyQualifiedName(java.lang.String name)
static ArchCondition<JavaClass>	notHaveModifier(JavaModifier modifier)
static ArchCondition<JavaClass>	notHaveSimpleName(java.lang.String name)
static ArchCondition<JavaClass>	notImplement(java.lang.Class<?> interfaceType)
static ArchCondition<JavaClass>	notImplement(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	notImplement(java.lang.String interfaceTypeName)
static ArchCondition<JavaClass>	onlyBeAccessedByAnyPackage(java.lang.String... packageIdentifiers)
static ArchCondition<JavaClass>	onlyBeAccessedByClassesThat(DescribedPredicate<? super JavaClass> predicate)
static ArchCondition<JavaClass>	onlyHaveDependentsInAnyPackage(java.lang.String... packageIdentifiers)
static ArchCondition<JavaClass>	onlyHaveDependentsWhere(DescribedPredicate<? super Dependency> predicate)
static ArchCondition<JavaClass>	resideInAnyPackage(java.lang.String... packageIdentifiers)
static ArchCondition<JavaClass>	resideInAPackage(java.lang.String packageIdentifier)
static ArchCondition<JavaClass>	resideOutsideOfPackage(java.lang.String packageIdentifier)
static ArchCondition<JavaClass>	resideOutsideOfPackages(java.lang.String... packageIdentifiers)
static ArchCondition<JavaClass>	setField(java.lang.Class<?> owner, java.lang.String fieldName)
static ArchCondition<JavaClass>	setField(java.lang.String ownerName, java.lang.String fieldName)
static ArchCondition<JavaClass>	setFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)

Methods inherited from class java.lang.Object

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

Method Detail

getField

public static ArchCondition<JavaClass> getField(java.lang.Class<?> owner,
                                java.lang.String fieldName)

getField

public static ArchCondition<JavaClass> getField(java.lang.String ownerName,
                                java.lang.String fieldName)

getFieldWhere

public static ArchCondition<JavaClass> getFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)

setField

public static ArchCondition<JavaClass> setField(java.lang.Class<?> owner,
                                java.lang.String fieldName)

setField

public static ArchCondition<JavaClass> setField(java.lang.String ownerName,
                                java.lang.String fieldName)

setFieldWhere

public static ArchCondition<JavaClass> setFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)

accessField

public static ArchCondition<JavaClass> accessField(java.lang.Class<?> owner,
                                   java.lang.String fieldName)

accessField

public static ArchCondition<JavaClass> accessField(java.lang.String ownerName,
                                   java.lang.String fieldName)

accessFieldWhere

public static ArchCondition<JavaClass> accessFieldWhere(DescribedPredicate<? super JavaFieldAccess> predicate)

callMethod

public static ArchCondition<JavaClass> callMethod(java.lang.Class<?> owner,
                                  java.lang.String methodName,
                                  java.lang.Class<?>... parameterTypes)

callMethod

public static ArchCondition<JavaClass> callMethod(java.lang.String ownerName,
                                  java.lang.String methodName,
                                  java.lang.String... parameterTypeNames)

callMethodWhere

public static ArchCondition<JavaClass> callMethodWhere(DescribedPredicate<? super JavaMethodCall> predicate)

callConstructor

public static ArchCondition<JavaClass> callConstructor(java.lang.Class<?> owner,
                                       java.lang.Class<?>... parameterTypes)

callConstructor

public static ArchCondition<JavaClass> callConstructor(java.lang.String ownerName,
                                       java.lang.String... parameterTypeNames)

callConstructorWhere

public static ArchCondition<JavaClass> callConstructorWhere(DescribedPredicate<? super JavaConstructorCall> predicate)

callCodeUnitWhere

public static ArchCondition<JavaClass> callCodeUnitWhere(DescribedPredicate<? super JavaCall<?>> predicate)

accessTargetWhere

public static ArchCondition<JavaClass> accessTargetWhere(DescribedPredicate<? super JavaAccess<?>> predicate)

accessClassesThat

public static ArchCondition<JavaClass> accessClassesThat(DescribedPredicate<? super JavaClass> predicate)

onlyBeAccessedByClassesThat

public static ArchCondition<JavaClass> onlyBeAccessedByClassesThat(DescribedPredicate<? super JavaClass> predicate)

accessClassesThatResideIn

public static ArchCondition<JavaClass> accessClassesThatResideIn(java.lang.String packageIdentifier)

Parameters:

packageIdentifier - A String identifying a package according to PackageMatcher

Returns:

A condition matching accesses to packages matching the identifier

accessClassesThatResideInAnyPackage

public static ArchCondition<JavaClass> accessClassesThatResideInAnyPackage(java.lang.String... packageIdentifiers)

Parameters:

packageIdentifiers - Strings identifying a package according to PackageMatcher

Returns:

A condition matching accesses to packages matching any of the identifiers

onlyBeAccessedByAnyPackage

public static ArchCondition<JavaClass> onlyBeAccessedByAnyPackage(java.lang.String... packageIdentifiers)

Parameters:

packageIdentifiers - Strings identifying packages according to PackageMatcher

Returns:

A condition matching accesses by packages matching any of the identifiers

onlyHaveDependentsInAnyPackage

public static ArchCondition<JavaClass> onlyHaveDependentsInAnyPackage(java.lang.String... packageIdentifiers)

Parameters:

packageIdentifiers - Strings identifying packages according to PackageMatcher

Returns:

A condition matching classes that have other classes depending on them (e.g. calling methods of this class) with a package matching any of the identifiers

onlyHaveDependentsWhere

public static ArchCondition<JavaClass> onlyHaveDependentsWhere(DescribedPredicate<? super Dependency> predicate)

Parameters:

predicate - A predicate identifying relevant dependencies on this class

Returns:

A condition matching classes that have other classes depending on them (e.g. calling methods of this class) where the respective dependency is matched by the predicate

never

public static <T> ArchCondition<T> never(ArchCondition<T> condition)

haveFullyQualifiedName

public static ArchCondition<JavaClass> haveFullyQualifiedName(java.lang.String name)

fullyQualifiedName

public static DescribedPredicate<HasName> fullyQualifiedName(java.lang.String name)

notHaveFullyQualifiedName

public static ArchCondition<JavaClass> notHaveFullyQualifiedName(java.lang.String name)

haveSimpleName

public static ArchCondition<JavaClass> haveSimpleName(java.lang.String name)

notHaveSimpleName

public static ArchCondition<JavaClass> notHaveSimpleName(java.lang.String name)

haveSimpleNameStartingWith

public static ArchCondition<JavaClass> haveSimpleNameStartingWith(java.lang.String prefix)

haveSimpleNameNotStartingWith

public static ArchCondition<JavaClass> haveSimpleNameNotStartingWith(java.lang.String prefix)

haveSimpleNameContaining

public static ArchCondition<JavaClass> haveSimpleNameContaining(java.lang.String infix)

haveSimpleNameNotContaining

public static ArchCondition<JavaClass> haveSimpleNameNotContaining(java.lang.String infix)

haveSimpleNameEndingWith

public static ArchCondition<JavaClass> haveSimpleNameEndingWith(java.lang.String suffix)

haveSimpleNameNotEndingWith

public static ArchCondition<JavaClass> haveSimpleNameNotEndingWith(java.lang.String suffix)

haveNameMatching

public static ArchCondition<JavaClass> haveNameMatching(java.lang.String regex)

haveNameNotMatching

public static ArchCondition<JavaClass> haveNameNotMatching(java.lang.String regex)

resideInAPackage

public static ArchCondition<JavaClass> resideInAPackage(java.lang.String packageIdentifier)

resideInAnyPackage

public static ArchCondition<JavaClass> resideInAnyPackage(java.lang.String... packageIdentifiers)

resideOutsideOfPackage

public static ArchCondition<JavaClass> resideOutsideOfPackage(java.lang.String packageIdentifier)

resideOutsideOfPackages

public static ArchCondition<JavaClass> resideOutsideOfPackages(java.lang.String... packageIdentifiers)

haveModifier

public static ArchCondition<JavaClass> haveModifier(JavaModifier modifier)

notHaveModifier

public static ArchCondition<JavaClass> notHaveModifier(JavaModifier modifier)

bePublic

public static ArchCondition<JavaClass> bePublic()

notBePublic

public static ArchCondition<JavaClass> notBePublic()

beProtected

public static ArchCondition<JavaClass> beProtected()

notBeProtected

public static ArchCondition<JavaClass> notBeProtected()

bePackagePrivate

public static ArchCondition<JavaClass> bePackagePrivate()

notBePackagePrivate

public static ArchCondition<JavaClass> notBePackagePrivate()

bePrivate

public static ArchCondition<JavaClass> bePrivate()

notBePrivate

public static ArchCondition<JavaClass> notBePrivate()

beAnnotatedWith

public static ArchCondition<JavaClass> beAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)

notBeAnnotatedWith

public static ArchCondition<JavaClass> notBeAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)

beAnnotatedWith

public static ArchCondition<JavaClass> beAnnotatedWith(java.lang.String typeName)

notBeAnnotatedWith

public static ArchCondition<JavaClass> notBeAnnotatedWith(java.lang.String typeName)

beAnnotatedWith

public static ArchCondition<JavaClass> beAnnotatedWith(DescribedPredicate<? super JavaAnnotation> predicate)

notBeAnnotatedWith

public static ArchCondition<JavaClass> notBeAnnotatedWith(DescribedPredicate<? super JavaAnnotation> predicate)

implement

public static ArchCondition<JavaClass> implement(java.lang.Class<?> interfaceType)

notImplement

public static ArchCondition<JavaClass> notImplement(java.lang.Class<?> interfaceType)

implement

public static ArchCondition<JavaClass> implement(java.lang.String interfaceTypeName)

notImplement

public static ArchCondition<JavaClass> notImplement(java.lang.String interfaceTypeName)

implement

public static ArchCondition<JavaClass> implement(DescribedPredicate<? super JavaClass> predicate)

notImplement

public static ArchCondition<JavaClass> notImplement(DescribedPredicate<? super JavaClass> predicate)

beAssignableTo

public static ArchCondition<JavaClass> beAssignableTo(java.lang.Class<?> type)

notBeAssignableTo

public static ArchCondition<JavaClass> notBeAssignableTo(java.lang.Class<?> type)

beAssignableTo

public static ArchCondition<JavaClass> beAssignableTo(java.lang.String typeName)

notBeAssignableTo

public static ArchCondition<JavaClass> notBeAssignableTo(java.lang.String typeName)

beAssignableTo

public static ArchCondition<JavaClass> beAssignableTo(DescribedPredicate<? super JavaClass> predicate)

notBeAssignableTo

public static ArchCondition<JavaClass> notBeAssignableTo(DescribedPredicate<? super JavaClass> predicate)

beAssignableFrom

public static ArchCondition<JavaClass> beAssignableFrom(java.lang.Class<?> type)

notBeAssignableFrom

public static ArchCondition<JavaClass> notBeAssignableFrom(java.lang.Class<?> type)

beAssignableFrom

public static ArchCondition<JavaClass> beAssignableFrom(java.lang.String typeName)

notBeAssignableFrom

public static ArchCondition<JavaClass> notBeAssignableFrom(java.lang.String typeName)

beAssignableFrom

public static ArchCondition<JavaClass> beAssignableFrom(DescribedPredicate<? super JavaClass> predicate)

notBeAssignableFrom

public static ArchCondition<JavaClass> notBeAssignableFrom(DescribedPredicate<? super JavaClass> predicate)

beInterfaces

public static ArchCondition<JavaClass> beInterfaces()

notBeInterfaces

public static ArchCondition<JavaClass> notBeInterfaces()