Package com.tngtech.archunit.lang.syntax.elements

Interface OnlyBeCalledSpecification<CONJUNCTION>

@PublicAPI(usage=ACCESS)
public interface OnlyBeCalledSpecification<CONJUNCTION>

Method Summary

Modifier and Type	Method	Description
ClassesThat<CONJUNCTION>	byClassesThat()
CONJUNCTION	byClassesThat(DescribedPredicate<? super JavaClass> predicate)	Restricts allowed origins of calls to classes matching the supplied DescribedPredicate.
CONJUNCTION	byCodeUnitsThat(DescribedPredicate<? super JavaCodeUnit> predicate)	Restricts allowed origins of calls to code units matching the supplied DescribedPredicate.
CONJUNCTION	byConstructorsThat(DescribedPredicate<? super JavaConstructor> predicate)	Restricts allowed origins of calls to constructors matching the supplied DescribedPredicate.
CONJUNCTION	byMethodsThat(DescribedPredicate<? super JavaMethod> predicate)	Restricts allowed origins of calls to methods matching the supplied DescribedPredicate.

Method Details

byClassesThat

@PublicAPI(usage=ACCESS)
CONJUNCTION byClassesThat(DescribedPredicate<? super JavaClass> predicate)

Restricts allowed origins of calls to classes matching the supplied DescribedPredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaClass can be found within JavaClass.Predicates or one of the respective ancestors like HasName.Predicates.

Parameters:

predicate - Restricts which classes the call should originate from. Every class that calls the respective JavaCodeUnit must match the predicate.

Returns:

A syntax conjunction element, which can be completed to form a full rule

byClassesThat

@PublicAPI(usage=ACCESS)
ClassesThat<CONJUNCTION> byClassesThat()

Returns:

A syntax element that allows restricting which classes the call should be from

byCodeUnitsThat

@PublicAPI(usage=ACCESS)
CONJUNCTION byCodeUnitsThat(DescribedPredicate<? super JavaCodeUnit> predicate)

Restricts allowed origins of calls to code units matching the supplied DescribedPredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaCodeUnit can be found within JavaCodeUnit.Predicates or one of the respective ancestors like JavaMember.Predicates.

Parameters:

predicate - Restricts which code units the call should originate from

Returns:

A syntax conjunction element, which can be completed to form a full rule

byMethodsThat

@PublicAPI(usage=ACCESS)
CONJUNCTION byMethodsThat(DescribedPredicate<? super JavaMethod> predicate)

Restricts allowed origins of calls to methods matching the supplied DescribedPredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaMethod can be found within JavaCodeUnit.Predicates or one of the respective ancestors like JavaMember.Predicates.

Parameters:

predicate - Restricts which methods the call should originate from. Calls from constructors are treated as mismatch.

Returns:

A syntax conjunction element, which can be completed to form a full rule

byConstructorsThat

@PublicAPI(usage=ACCESS)
CONJUNCTION byConstructorsThat(DescribedPredicate<? super JavaConstructor> predicate)

Restricts allowed origins of calls to constructors matching the supplied DescribedPredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaConstructor can be found within JavaCodeUnit.Predicates or one of the respective ancestors like JavaMember.Predicates.

Parameters:

predicate - Restricts which constructors the call should originate from. Calls from methods are treated as mismatch.

Returns:

A syntax conjunction element, which can be completed to form a full rule