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

Interface FieldsThat<CONJUNCTION>

All Superinterfaces:

MembersThat<CONJUNCTION>

@PublicAPI(usage=ACCESS)
public interface FieldsThat<CONJUNCTION>
extends MembersThat<CONJUNCTION>

Method Summary

Modifier and Type	Method	Description
CONJUNCTION	areFinal()	Matches final fields.
CONJUNCTION	areNotFinal()	Matches non-final fields.
CONJUNCTION	areNotStatic()	Matches non-static fields.
CONJUNCTION	areStatic()	Matches static fields.
CONJUNCTION	doNotHaveRawType(DescribedPredicate<? super JavaClass> predicate)	Matches fields where the raw type of those fields does not match the given predicate.
CONJUNCTION	doNotHaveRawType(Class<?> type)	Matches fields that do not have the given raw type.
CONJUNCTION	doNotHaveRawType(String typeName)	Matches fields that do not have the given fully qualified name of their raw type.
CONJUNCTION	haveRawType(DescribedPredicate<? super JavaClass> predicate)	Matches fields where the raw type of those fields matches the given predicate.
CONJUNCTION	haveRawType(Class<?> type)	Matches fields by their raw type.
CONJUNCTION	haveRawType(String typeName)	Matches fields by the fully qualified name of their raw type.

Methods inherited from interface com.tngtech.archunit.lang.syntax.elements.MembersThat

areAnnotatedWith, areAnnotatedWith, areAnnotatedWith, areDeclaredIn, areDeclaredIn, areDeclaredInClassesThat, areDeclaredInClassesThat, areMetaAnnotatedWith, areMetaAnnotatedWith, areMetaAnnotatedWith, areNotAnnotatedWith, areNotAnnotatedWith, areNotAnnotatedWith, areNotDeclaredIn, areNotDeclaredIn, areNotMetaAnnotatedWith, areNotMetaAnnotatedWith, areNotMetaAnnotatedWith, areNotPackagePrivate, areNotPrivate, areNotProtected, areNotPublic, arePackagePrivate, arePrivate, areProtected, arePublic, doNotHaveFullName, doNotHaveModifier, doNotHaveName, haveFullName, haveFullNameMatching, haveFullNameNotMatching, haveModifier, haveName, haveNameContaining, haveNameEndingWith, haveNameMatching, haveNameNotContaining, haveNameNotEndingWith, haveNameNotMatching, haveNameNotStartingWith, haveNameStartingWith

Method Details

haveRawType

@PublicAPI(usage=ACCESS)
CONJUNCTION haveRawType(Class<?> type)

Matches fields by their raw type. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().haveRawType(String.class)

Parameters:

type - Type matching fields must have

Returns:

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

doNotHaveRawType

@PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveRawType(Class<?> type)

Matches fields that do not have the given raw type. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().doNotHaveRawType(Object.class)

Parameters:

type - Type matching fields must not have

Returns:

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

haveRawType

@PublicAPI(usage=ACCESS)
CONJUNCTION haveRawType(String typeName)

Matches fields by the fully qualified name of their raw type. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().haveRawType(String.class.getName())

Parameters:

typeName - Name of type matching fields must have

Returns:

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

doNotHaveRawType

@PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveRawType(String typeName)

Matches fields that do not have the given fully qualified name of their raw type. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().doNotHaveRawType(Object.class.getName())

Parameters:

typeName - Name of type matching fields must not have

Returns:

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

haveRawType

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

Matches fields where the raw type of those fields matches the given predicate. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().haveRawType(assignableTo(Serializable.class))

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 - A predicate determining which types of fields match

Returns:

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

doNotHaveRawType

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

Matches fields where the raw type of those fields does not match the given predicate. Take for example

 class Example {
     String someField;
 }
 

Then someField would be matched by

fields().that().doNotHaveRawType(assignableTo(List.class))

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 - A predicate determining which types of fields do not match

Returns:

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

areStatic

@PublicAPI(usage=ACCESS)
CONJUNCTION areStatic()

Matches static fields.

Returns:

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

areNotStatic

@PublicAPI(usage=ACCESS)
CONJUNCTION areNotStatic()

Matches non-static fields.

Returns:

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

areFinal

@PublicAPI(usage=ACCESS)
CONJUNCTION areFinal()

Matches final fields.

Returns:

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

areNotFinal

@PublicAPI(usage=ACCESS)
CONJUNCTION areNotFinal()

Matches non-final fields.

Returns:

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