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

Interface OnlyBeAccessedSpecification<CONJUNCTION>

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

Method Summary

Modifier and Type	Method	Description
CONJUNCTION	byAnyPackage(String... packageIdentifiers)	Matches classes residing in a package matching any of the supplied package identifiers.
ClassesThat<ClassesShouldConjunction>	byClassesThat()
CONJUNCTION	byClassesThat(DescribedPredicate<? super JavaClass> predicate)	Allows to restrict the access origins by matching them against the supplied DescribedPredicate.

Method Details

byAnyPackage

@PublicAPI(usage=ACCESS)
CONJUNCTION byAnyPackage(String... packageIdentifiers)

Matches classes residing in a package matching any of the supplied package identifiers.

Parameters:

packageIdentifiers - Strings identifying packages, for details see PackageMatcher

Returns:

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

byClassesThat

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

Returns:

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

byClassesThat

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

Allows to restrict the access origins by matching them against 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 access should be from

Returns:

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