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

Interface FieldsShould<CONJUNCTION extends FieldsShouldConjunction>

All Superinterfaces:

MembersShould<CONJUNCTION>

@PublicAPI(usage=ACCESS)
public interface FieldsShould<CONJUNCTION extends FieldsShouldConjunction>
extends MembersShould<CONJUNCTION>

Method Summary

Modifier and Type	Method	Description
CONJUNCTION	beAccessedByMethodsThat(DescribedPredicate<? super JavaMethod> predicate)	Asserts that fields are accessed by at least one method matching the given predicate.
CONJUNCTION	beFinal()	Asserts that fields are final.
CONJUNCTION	beStatic()	Asserts that fields are static.
CONJUNCTION	haveRawType(DescribedPredicate<? super JavaClass> predicate)	Asserts that fields have a raw type matching the given predicate.
CONJUNCTION	haveRawType(Class<?> type)	Asserts that fields have a certain raw type.
CONJUNCTION	haveRawType(String typeName)	Asserts that fields have a certain fully qualified name of their raw type.
CONJUNCTION	notBeAccessedByMethodsThat(DescribedPredicate<? super JavaMethod> predicate)	Asserts that fields are not accessed by methods matching the given predicate.
CONJUNCTION	notBeFinal()	Asserts that fields are non-final.
CONJUNCTION	notBeStatic()	Asserts that fields are non-static.
CONJUNCTION	notHaveRawType(DescribedPredicate<? super JavaClass> predicate)	Asserts that fields do not have a raw type matching the given predicate.
CONJUNCTION	notHaveRawType(Class<?> type)	Asserts that fields do not have a certain raw type.
CONJUNCTION	notHaveRawType(String typeName)	Asserts that fields do not have a certain fully qualified name of their raw type.

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

beAnnotatedWith, beAnnotatedWith, beAnnotatedWith, beDeclaredIn, beDeclaredIn, beDeclaredInClassesThat, beDeclaredInClassesThat, beMetaAnnotatedWith, beMetaAnnotatedWith, beMetaAnnotatedWith, bePackagePrivate, bePrivate, beProtected, bePublic, containNumberOfElements, haveFullName, haveFullNameMatching, haveFullNameNotMatching, haveModifier, haveName, haveNameContaining, haveNameEndingWith, haveNameMatching, haveNameNotContaining, haveNameNotEndingWith, haveNameNotMatching, haveNameNotStartingWith, haveNameStartingWith, notBeAnnotatedWith, notBeAnnotatedWith, notBeAnnotatedWith, notBeDeclaredIn, notBeDeclaredIn, notBeMetaAnnotatedWith, notBeMetaAnnotatedWith, notBeMetaAnnotatedWith, notBePackagePrivate, notBePrivate, notBeProtected, notBePublic, notHaveFullName, notHaveModifier, notHaveName

Method Details

haveRawType

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

Asserts that fields have a certain raw type.

E.g.

 fields().should().haveRawType(String.class)
 

would be violated by someField in

 class Example {
     Object someField;
 }

Parameters:

type - Type fields should have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

notHaveRawType

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

Asserts that fields do not have a certain raw type.

E.g.

 fields().should().notHaveRawType(String.class)
 

would be violated by someField in

 class Example {
     String someField;
 }

Parameters:

type - Type fields should not have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

haveRawType

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

Asserts that fields have a certain fully qualified name of their raw type.

E.g.

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

would be violated by someField in

 class Example {
     Object someField;
 }

Parameters:

typeName - Name of type fields should have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

notHaveRawType

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

Asserts that fields do not have a certain fully qualified name of their raw type.

E.g.

 fields().should().notHaveRawType(String.class.getName())
 

would be violated by someField in

 class Example {
     String someField;
 }

Parameters:

typeName - Name of type fields should not have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

haveRawType

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

Asserts that fields have a raw type matching the given predicate.

E.g.

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

would be violated by someField in

 class Example {
     Object someField;
 }

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 sort of types fields should have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

notHaveRawType

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

Asserts that fields do not have a raw type matching the given predicate.

E.g.

 fields().should().notHaveRawType(assignableTo(Serializable.class))
 

would be violated by someField in

 class Example {
     String someField;
 }

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 sort of types fields should not have

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

beAccessedByMethodsThat

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

Asserts that fields are accessed by at least one method matching the given predicate. This mostly makes sense in the negated form

 noFields().should().beAccessedByMethodsThat(DescribedPredicate)
 

In this form it is equivalent to

 ArchRuleDefinition.fields() fields()}.should().notBeAccessedByMethodsThat(DescribedPredicate)
 

but might be useful for chaining multiple conditions via FieldsShouldConjunction.andShould().

Parameters:

predicate - A predicate determining the methods this field should not be accessed by

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

See Also:

• notBeAccessedByMethodsThat(DescribedPredicate)

notBeAccessedByMethodsThat

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

Asserts that fields are not accessed by methods matching the given predicate.

Parameters:

predicate - A predicate determining the methods this field should not be accessed by

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

See Also:

• beAccessedByMethodsThat(DescribedPredicate)

beStatic

@PublicAPI(usage=ACCESS)
CONJUNCTION beStatic()

Asserts that fields are static.

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

notBeStatic

@PublicAPI(usage=ACCESS)
CONJUNCTION notBeStatic()

Asserts that fields are non-static.

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

beFinal

@PublicAPI(usage=ACCESS)
CONJUNCTION beFinal()

Asserts that fields are final.

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule

notBeFinal

@PublicAPI(usage=ACCESS)
CONJUNCTION notBeFinal()

Asserts that fields are non-final.

Returns:

A syntax element that can either be used as working rule, or to continue specifying a more complex rule