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

Interface CodeUnitsThat<CONJUNCTION>

All Superinterfaces:

MembersThat<CONJUNCTION>

All Known Subinterfaces:

MethodsThat<CONJUNCTION>

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

Method Summary

Modifier and Type	Method	Description
CONJUNCTION	declareThrowableOfType(DescribedPredicate<? super JavaClass> predicate)	Matches JavaCodeUnits that declare a Throwable which matches the given predicate.
CONJUNCTION	declareThrowableOfType(Class<? extends Throwable> type)	Matches JavaCodeUnits that declare a Throwable of the specified type in their throws clause.
CONJUNCTION	declareThrowableOfType(String typeName)	Matches JavaCodeUnits that declare a Throwable of the specified fully qualified type name in their throws clause.
CONJUNCTION	doNotDeclareThrowableOfType(DescribedPredicate<? super JavaClass> predicate)	Matches JavaCodeUnits that do not declare a Throwable which matches the given predicate.
CONJUNCTION	doNotDeclareThrowableOfType(Class<? extends Throwable> type)	Matches JavaCodeUnits that do not declare a Throwable of the specified type in their throws clause.
CONJUNCTION	doNotDeclareThrowableOfType(String typeName)	Matches JavaCodeUnits that do not declare a Throwable of the specified fully qualified type name in their throws clause.
CONJUNCTION	doNotHaveRawParameterTypes(DescribedPredicate<? super List<JavaClass>> predicate)	Matches JavaCodeUnits that do not have raw parameter types matching the given predicate.
CONJUNCTION	doNotHaveRawParameterTypes(Class<?>... parameterTypes)	Matches JavaCodeUnits that do not have the specified raw parameter types.
CONJUNCTION	doNotHaveRawParameterTypes(String... parameterTypeNames)	Matches JavaCodeUnits that do not have the specified fully qualified raw parameter type names.
CONJUNCTION	doNotHaveRawReturnType(DescribedPredicate<? super JavaClass> predicate)	Matches JavaCodeUnits that do not have raw return types matching the given predicate.
CONJUNCTION	doNotHaveRawReturnType(Class<?> type)	Matches JavaCodeUnits that do not have the specified raw return types.
CONJUNCTION	doNotHaveRawReturnType(String typeName)	Matches JavaCodeUnits that do not have the specified fully qualified raw return type name.
CONJUNCTION	haveRawParameterTypes(DescribedPredicate<? super List<JavaClass>> predicate)	Matches JavaCodeUnits that have raw parameter types matching the given predicate.
CONJUNCTION	haveRawParameterTypes(Class<?>... parameterTypes)	Matches JavaCodeUnits that have the specified raw parameter types.
CONJUNCTION	haveRawParameterTypes(String... parameterTypeNames)	Matches JavaCodeUnits that have the specified fully qualified raw parameter type names.
CONJUNCTION	haveRawReturnType(DescribedPredicate<? super JavaClass> predicate)	Matches JavaCodeUnits that have raw return types matching the given predicate.
CONJUNCTION	haveRawReturnType(Class<?> type)	Matches JavaCodeUnits that have the specified raw return types.
CONJUNCTION	haveRawReturnType(String typeName)	Matches JavaCodeUnits that have the specified fully qualified raw return type name.

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

haveRawParameterTypes

@PublicAPI(usage=ACCESS)
CONJUNCTION haveRawParameterTypes(Class<?>... parameterTypes)

Matches JavaCodeUnits that have the specified raw parameter types. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawParameterTypes(String.class, int.class)

Parameters:

parameterTypes - Parameter types to match JavaCodeUnits against

Returns:

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

doNotHaveRawParameterTypes

@PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveRawParameterTypes(Class<?>... parameterTypes)

Matches JavaCodeUnits that do not have the specified raw parameter types. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawParameterTypes(String.class)

Parameters:

parameterTypes - Parameter types matching JavaCodeUnits may not have

Returns:

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

haveRawParameterTypes

@PublicAPI(usage=ACCESS)
CONJUNCTION haveRawParameterTypes(String... parameterTypeNames)

Matches JavaCodeUnits that have the specified fully qualified raw parameter type names. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawParameterTypes(String.class.getName(), int.class.getName())

Parameters:

parameterTypeNames - Fully qualified names of parameter types to match JavaCodeUnits against

Returns:

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

doNotHaveRawParameterTypes

@PublicAPI(usage=ACCESS)
CONJUNCTION doNotHaveRawParameterTypes(String... parameterTypeNames)

Matches JavaCodeUnits that do not have the specified fully qualified raw parameter type names. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawParameterTypes(String.class.getName())

Parameters:

parameterTypeNames - Fully qualified names of parameter types matching JavaCodeUnits may not have

Returns:

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

haveRawParameterTypes

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

Matches JavaCodeUnits that have raw parameter types matching the given predicate. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawParameterTypes(whereFirstTypeIs(String.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 DescribedPredicate that determines, which JavaCodeUnits match by their raw parameter types

Returns:

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

doNotHaveRawParameterTypes

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

Matches JavaCodeUnits that do not have raw parameter types matching the given predicate. Take for example

 class Example {
     void someMethod(String stringParam, int intParam) {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawParameterTypes(whereFirstTypeIs(int.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 DescribedPredicate that determines, which JavaCodeUnits do not match by their raw parameter types

Returns:

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

haveRawReturnType

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

Matches JavaCodeUnits that have the specified raw return types. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawReturnType(String.class)

Parameters:

type - Return type to match JavaCodeUnits against

Returns:

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

doNotHaveRawReturnType

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

Matches JavaCodeUnits that do not have the specified raw return types. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawReturnType(Object.class)

Parameters:

type - Return type matching JavaCodeUnits may not have

Returns:

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

haveRawReturnType

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

Matches JavaCodeUnits that have the specified fully qualified raw return type name. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawReturnType(String.class.getName())

Parameters:

typeName - Fully qualified name of a return type to match JavaCodeUnits against

Returns:

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

doNotHaveRawReturnType

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

Matches JavaCodeUnits that do not have the specified fully qualified raw return type name. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawReturnType(Object.class.getName())

Parameters:

typeName - Fully qualified name of a return type matching JavaCodeUnits may not have

Returns:

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

haveRawReturnType

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

Matches JavaCodeUnits that have raw return types matching the given predicate. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().haveRawReturnType(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 DescribedPredicate that determines, which JavaCodeUnits match by their raw return types

Returns:

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

doNotHaveRawReturnType

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

Matches JavaCodeUnits that do not have raw return types matching the given predicate. Take for example

 class Example {
     String someMethod() {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotHaveRawReturnType(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 DescribedPredicate that determines, which JavaCodeUnits do not match by their raw return types

Returns:

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

declareThrowableOfType

@PublicAPI(usage=ACCESS)
CONJUNCTION declareThrowableOfType(Class<? extends Throwable> type)

Matches JavaCodeUnits that declare a Throwable of the specified type in their throws clause. Take for example

 class Example {
     void someMethod() throws FirstException, SecondException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().declareThrowableOfType(FirstException.class)

Parameters:

type - Type of a declared Throwable to match JavaCodeUnits against

Returns:

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

doNotDeclareThrowableOfType

@PublicAPI(usage=ACCESS)
CONJUNCTION doNotDeclareThrowableOfType(Class<? extends Throwable> type)

Matches JavaCodeUnits that do not declare a Throwable of the specified type in their throws clause. Take for example

 class Example {
     void someMethod() throws FirstException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotDeclareThrowableOfType(SecondException.class)

Parameters:

type - Type of a declared Throwable matching JavaCodeUnits may not have

Returns:

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

declareThrowableOfType

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

Matches JavaCodeUnits that declare a Throwable of the specified fully qualified type name in their throws clause. Take for example

 class Example {
     void someMethod() throws FirstException, SecondException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().declareThrowableOfType(FirstException.class.getName())

Parameters:

typeName - Fully qualified name of a type of a declared Throwable to match JavaCodeUnits against

Returns:

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

doNotDeclareThrowableOfType

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

Matches JavaCodeUnits that do not declare a Throwable of the specified fully qualified type name in their throws clause. Take for example

 class Example {
     void someMethod() throws FirstException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotDeclareThrowableOfType(SecondException.class.getName())

Parameters:

typeName - Fully qualified name of a type of a declared Throwable matching JavaCodeUnits may not have

Returns:

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

declareThrowableOfType

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

Matches JavaCodeUnits that declare a Throwable which matches the given predicate. Take for example

 class Example {
     void someMethod() throws FirstException, SecondException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().declareThrowableOfType(nameStartingWith("First"))

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 DescribedPredicate that determines, which JavaCodeUnits match by their declared Throwable

Returns:

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

doNotDeclareThrowableOfType

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

Matches JavaCodeUnits that do not declare a Throwable which matches the given predicate. Take for example

 class Example {
     void someMethod() throws FirstException {...}
 }
 

Then someMethod would be matched by

codeUnits().that().doNotDeclareThrowableOfType(nameStartingWith("Second"))

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 DescribedPredicate that determines, which JavaCodeUnits do not match by their declared Throwable

Returns:

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