Package com.tngtech.archunit.core.domain

Class JavaClass.Predicates

java.lang.Object

com.tngtech.archunit.core.domain.JavaClass.Predicates

Enclosing class:

JavaClass

public static final class JavaClass.Predicates
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static DescribedPredicate<JavaClass>	ANONYMOUS_CLASSES
static DescribedPredicate<JavaClass>	ENUMS
static DescribedPredicate<JavaClass>	INNER_CLASSES
static DescribedPredicate<JavaClass>	INTERFACES
static DescribedPredicate<JavaClass>	LOCAL_CLASSES
static DescribedPredicate<JavaClass>	MEMBER_CLASSES
static DescribedPredicate<JavaClass>	NESTED_CLASSES
static DescribedPredicate<JavaClass>	TOP_LEVEL_CLASSES

Method Summary

Modifier and Type	Method	Description
static DescribedPredicate<JavaClass>	assignableFrom(DescribedPredicate<? super JavaClass> predicate)
static DescribedPredicate<JavaClass>	assignableFrom(java.lang.Class<?> type)
static DescribedPredicate<JavaClass>	assignableFrom(java.lang.String typeName)
static DescribedPredicate<JavaClass>	assignableTo(DescribedPredicate<? super JavaClass> predicate)
static DescribedPredicate<JavaClass>	assignableTo(java.lang.Class<?> type)
static DescribedPredicate<JavaClass>	assignableTo(java.lang.String typeName)
static DescribedPredicate<JavaClass>	belongToAnyOf(java.lang.Class<?>... classes)	A predicate to determine if a JavaClass "belongs" to one of the passed classes, where we define "belong" as being equivalent to the class itself or any inner/anonymous class of this class.
static DescribedPredicate<JavaClass>	equivalentTo(java.lang.Class<?> clazz)
static DescribedPredicate<JavaClass>	implement(DescribedPredicate<? super JavaClass> predicate)
static DescribedPredicate<JavaClass>	implement(java.lang.Class<?> type)
static DescribedPredicate<JavaClass>	implement(java.lang.String typeName)
static DescribedPredicate<JavaClass>	resideInAnyPackage(java.lang.String... packageIdentifiers)
static DescribedPredicate<JavaClass>	resideInAPackage(java.lang.String packageIdentifier)	Offers a syntax to identify packages similar to AspectJ.
static DescribedPredicate<JavaClass>	resideOutsideOfPackage(java.lang.String packageIdentifier)
static DescribedPredicate<JavaClass>	resideOutsideOfPackages(java.lang.String... packageIdentifiers)
static DescribedPredicate<JavaClass>	simpleName(java.lang.String name)
static DescribedPredicate<JavaClass>	simpleNameContaining(java.lang.String infix)
static DescribedPredicate<JavaClass>	simpleNameEndingWith(java.lang.String suffix)
static DescribedPredicate<JavaClass>	simpleNameStartingWith(java.lang.String prefix)
static DescribedPredicate<JavaClass>	type(java.lang.Class<?> type)

Methods inherited from class java.lang.Object

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

Field Detail

INTERFACES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> INTERFACES

ENUMS

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> ENUMS

TOP_LEVEL_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> TOP_LEVEL_CLASSES

NESTED_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> NESTED_CLASSES

MEMBER_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> MEMBER_CLASSES

INNER_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> INNER_CLASSES

LOCAL_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> LOCAL_CLASSES

ANONYMOUS_CLASSES

@PublicAPI(usage=ACCESS)
public static final DescribedPredicate<JavaClass> ANONYMOUS_CLASSES

Method Detail

type

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> type(java.lang.Class<?> type)

simpleName

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> simpleName(java.lang.String name)

simpleNameStartingWith

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> simpleNameStartingWith(java.lang.String prefix)

simpleNameContaining

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> simpleNameContaining(java.lang.String infix)

simpleNameEndingWith

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> simpleNameEndingWith(java.lang.String suffix)

assignableTo

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableTo(java.lang.Class<?> type)

assignableFrom

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableFrom(java.lang.Class<?> type)

assignableTo

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableTo(java.lang.String typeName)

assignableFrom

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableFrom(java.lang.String typeName)

assignableTo

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableTo(DescribedPredicate<? super JavaClass> predicate)

assignableFrom

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> assignableFrom(DescribedPredicate<? super JavaClass> predicate)

implement

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> implement(java.lang.Class<?> type)

implement

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> implement(java.lang.String typeName)

implement

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> implement(DescribedPredicate<? super JavaClass> predicate)

resideInAPackage

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> resideInAPackage(java.lang.String packageIdentifier)

Offers a syntax to identify packages similar to AspectJ. In particular '*' stands for any sequence of characters, '..' stands for any sequence of packages. For further details see PackageMatcher.

Parameters:

packageIdentifier - A string representing the identifier to match packages against

Returns:

A DescribedPredicate returning true iff the package of the tested JavaClass matches the identifier

resideInAnyPackage

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> resideInAnyPackage(java.lang.String... packageIdentifiers)

See Also:

resideInAPackage(String)

resideOutsideOfPackage

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> resideOutsideOfPackage(java.lang.String packageIdentifier)

resideOutsideOfPackages

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> resideOutsideOfPackages(java.lang.String... packageIdentifiers)

equivalentTo

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> equivalentTo(java.lang.Class<?> clazz)

See Also:

JavaClass.isEquivalentTo(Class)

belongToAnyOf

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<JavaClass> belongToAnyOf(java.lang.Class<?>... classes)

A predicate to determine if a JavaClass "belongs" to one of the passed classes, where we define "belong" as being equivalent to the class itself or any inner/anonymous class of this class.

Parameters:

classes - The classes to check the JavaClass against

Returns:

A DescribedPredicate returning true, if and only if the tested JavaClass is equivalent to one of the supplied classes or to one of its inner/anonymous classes.