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

Interface MembersThat<CONJUNCTION extends GivenMembersConjunction<?>>

    • Method Detail

      • doNotHaveName

        @PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveName​(java.lang.String name)
        Matches members that do not have a certain name (i.e. field name, method name or JavaConstructor.CONSTRUCTOR_NAME).
        Parameters:
        name - The member name
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameMatching

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameMatching​(java.lang.String regex)
        Matches members with a name (i.e. field name, method name or JavaConstructor.CONSTRUCTOR_NAME) matching a given regular expression.
        Parameters:
        regex - A regular expression
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameNotMatching

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameNotMatching​(java.lang.String regex)
        Matches members with a name (i.e. field name, method name or JavaConstructor.CONSTRUCTOR_NAME) not matching a given regular expression.
        Parameters:
        regex - A regular expression
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveFullName

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveFullName​(java.lang.String fullName)
        Matches members by their full name.
        Parameters:
        fullName - The member's full name
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • doNotHaveFullName

        @PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveFullName​(java.lang.String fullName)
        Matches members that do not have a certain full name.
        Parameters:
        fullName - The member's full name
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveFullNameMatching

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveFullNameMatching​(java.lang.String regex)
        Matches members with a full name matching a given regular expression.
        Parameters:
        regex - A regular expression
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveFullNameNotMatching

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveFullNameNotMatching​(java.lang.String regex)
        Matches members with a full name not matching a given regular expression.
        Parameters:
        regex - A regular expression
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameStartingWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameStartingWith​(java.lang.String prefix)
        Matches members with a name starting with the specified prefix.
        Parameters:
        prefix - A prefix the member name should start with
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameNotStartingWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameNotStartingWith​(java.lang.String prefix)
        Matches members with a name not starting with the specified prefix.
        Parameters:
        prefix - A prefix the member name should not start with
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameContaining

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameContaining​(java.lang.String infix)
        Matches members with a name containing the specified infix.
        Parameters:
        infix - An infix the member name should contain
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameNotContaining

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameNotContaining​(java.lang.String infix)
        Matches members with a name not containing the specified infix.
        Parameters:
        infix - An infix the member name should not contain
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameEndingWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameEndingWith​(java.lang.String suffix)
        Matches members with a name ending with the specified suffix.
        Parameters:
        suffix - A suffix the member name should end with
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • haveNameNotEndingWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION haveNameNotEndingWith​(java.lang.String suffix)
        Matches members with a name not ending with the specified suffix.
        Parameters:
        suffix - A suffix the member name should not end with
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • arePublic

        @PublicAPI(usage=ACCESS)
CONJUNCTION arePublic()
        Matches public members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotPublic

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotPublic()
        Matches non-public members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areProtected

        @PublicAPI(usage=ACCESS)
CONJUNCTION areProtected()
        Matches protected members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotProtected

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotProtected()
        Matches non-protected members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • arePackagePrivate

        @PublicAPI(usage=ACCESS)
CONJUNCTION arePackagePrivate()
        Matches package private members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotPackagePrivate

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotPackagePrivate()
        Matches non-package private members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • arePrivate

        @PublicAPI(usage=ACCESS)
CONJUNCTION arePrivate()
        Matches private members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotPrivate

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotPrivate()
        Matches non-private members.
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        Matches members annotated with a certain type of annotation.
        Parameters:
        annotationType - Specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        Matches members not annotated with a certain type of annotation.
        Parameters:
        annotationType - Specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areAnnotatedWith​(java.lang.String annotationTypeName)
        Matches members annotated with a certain type of annotation.
        Parameters:
        annotationTypeName - Fully qualified class name of a specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotAnnotatedWith​(java.lang.String annotationTypeName)
        Matches members not annotated with a certain type of annotation.
        Parameters:
        annotationTypeName - Fully qualified class name of a specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areAnnotatedWith​(DescribedPredicate<? super JavaAnnotation<?>> predicate)
        Matches members annotated with a certain annotation, where matching annotations are determined by the supplied predicate.
        Parameters:
        predicate - A predicate defining matching JavaAnnotations
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotAnnotatedWith​(DescribedPredicate<? super JavaAnnotation<?>> predicate)
        Matches members not annotated with a certain annotation, where matching annotations are determined by the supplied predicate.
        Parameters:
        predicate - A predicate defining matching JavaAnnotations
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areMetaAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        Matches members meta-annotated with a certain type of annotation. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        annotationType - Specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotMetaAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        Matches members not meta-annotated with a certain type of annotation. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        annotationType - Specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areMetaAnnotatedWith​(java.lang.String annotationTypeName)
        Matches members meta-annotated with a certain type of annotation. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        annotationTypeName - Fully qualified class name of a specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotMetaAnnotatedWith​(java.lang.String annotationTypeName)
        Matches members not meta-annotated with a certain type of annotation. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        annotationTypeName - Fully qualified class name of a specific type of Annotation
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areMetaAnnotatedWith​(DescribedPredicate<? super JavaAnnotation<?>> predicate)
        Matches members meta-annotated with a certain annotation, where matching meta-annotations are determined by the supplied predicate. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        predicate - A predicate defining matching JavaAnnotations
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotMetaAnnotatedWith

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotMetaAnnotatedWith​(DescribedPredicate<? super JavaAnnotation<?>> predicate)
        Matches members not meta-annotated with a certain annotation, where matching meta-annotations are determined by the supplied predicate. A meta-annotation is an annotation that is declared on another annotation.
        Parameters:
        predicate - A predicate defining matching JavaAnnotations
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areDeclaredIn

        @PublicAPI(usage=ACCESS)
CONJUNCTION areDeclaredIn​(java.lang.Class<?> javaClass)
        Matches members declared within the supplied class.

        E.g. someField in 
        
 class Example {
     Object someField;
 }
        will be matched by 
        
 members().that().areDeclaredIn(Example.class)
        Parameters:
        javaClass - A class that members have to be declared in to match
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotDeclaredIn

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotDeclaredIn​(java.lang.Class<?> javaClass)
        Matches members not declared within the supplied class.

        E.g. someField in 
        
 class Example {
     Object someField;
 }
        will not be matched by 
        
 members().that().areNotDeclaredIn(Example.class)
        Parameters:
        javaClass - A class that members must not be declared in to match
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areDeclaredIn

        @PublicAPI(usage=ACCESS)
CONJUNCTION areDeclaredIn​(java.lang.String className)
        Matches members declared within a class of the supplied class name.

        E.g. someField in 
        
 class Example {
     Object someField;
 }
        will be matched by 
        
 members().that().areDeclaredIn(Example.class.getName())
        Parameters:
        className - Fully qualified name of a class that members have to be declared in to match
        Returns:
        A syntax conjunction element, which can be completed to form a full rule

      • areNotDeclaredIn

        @PublicAPI(usage=ACCESS)
CONJUNCTION areNotDeclaredIn​(java.lang.String className)
        Matches members not declared within a class of the supplied class name.

        E.g. someField in 
        
 class Example {
     Object someField;
 }
        will not be matched by 
        
 members().that().areNotDeclaredIn(Example.class.getName())
        Parameters:
        className - Fully qualified name of a class that members must not be declared in to match
        Returns:
        A syntax conjunction element, which can be completed to form a full rule