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

Interface CodeUnitsShould<CONJUNCTION extends CodeUnitsShouldConjunction<?>>

All Superinterfaces:

MembersShould<CONJUNCTION>

All Known Subinterfaces:

MethodsShould<CONJUNCTION>

@PublicAPI(usage=ACCESS)
public interface CodeUnitsShould<CONJUNCTION extends CodeUnitsShouldConjunction<?>>
extends MembersShould<CONJUNCTION>

Method Summary

Modifier and Type	Method	Description
CONJUNCTION	declareThrowableOfType(DescribedPredicate<? super JavaClass> predicate)	Asserts that JavaCodeUnits declare a Throwable which matches the given predicate.
CONJUNCTION	declareThrowableOfType(Class<? extends Throwable> type)	Asserts that JavaCodeUnits declare a Throwable of the specified type in their throws clause.
CONJUNCTION	declareThrowableOfType(String typeName)	Asserts that JavaCodeUnits declare a Throwable of the specified fully qualified type name in their throws clause.
CONJUNCTION	haveRawParameterTypes(DescribedPredicate<? super List<JavaClass>> predicate)	Asserts that JavaCodeUnits have raw parameter types matching the given predicate.
CONJUNCTION	haveRawParameterTypes(Class<?>... parameterTypes)	Asserts that JavaCodeUnits have the specified raw parameter types.
CONJUNCTION	haveRawParameterTypes(String... parameterTypeNames)	Asserts that JavaCodeUnits have the specified fully qualified raw parameter type names.
CONJUNCTION	haveRawReturnType(DescribedPredicate<? super JavaClass> predicate)	Asserts that JavaCodeUnits have raw return types matching the given predicate.
CONJUNCTION	haveRawReturnType(Class<?> type)	Asserts that JavaCodeUnits have the specified raw return type.
CONJUNCTION	haveRawReturnType(String typeName)	Asserts that JavaCodeUnits have the specified fully qualified raw return type name.
CONJUNCTION	notDeclareThrowableOfType(DescribedPredicate<? super JavaClass> predicate)	Asserts that JavaCodeUnits do not declare a Throwable which matches the given predicate.
CONJUNCTION	notDeclareThrowableOfType(Class<? extends Throwable> type)	Asserts that JavaCodeUnits do not declare a Throwable of the specified type in their throws clause.
CONJUNCTION	notDeclareThrowableOfType(String typeName)	Asserts that JavaCodeUnits do not declare a Throwable of the specified fully qualified type name in their throws clause.
CONJUNCTION	notHaveRawParameterTypes(DescribedPredicate<? super List<JavaClass>> predicate)	Asserts that JavaCodeUnits do not have raw parameter types matching the given predicate.
CONJUNCTION	notHaveRawParameterTypes(Class<?>... parameterTypes)	Asserts that JavaCodeUnits do not have the specified raw parameter types.
CONJUNCTION	notHaveRawParameterTypes(String... parameterTypeNames)	Asserts that JavaCodeUnits do not have the specified fully qualified raw parameter type names.
CONJUNCTION	notHaveRawReturnType(DescribedPredicate<? super JavaClass> predicate)	Asserts that JavaCodeUnits do not have raw return types matching the given predicate.
CONJUNCTION	notHaveRawReturnType(Class<?> type)	Asserts that JavaCodeUnits do not have the specified raw return type.
CONJUNCTION	notHaveRawReturnType(String typeName)	Asserts that JavaCodeUnits do not have the specified fully qualified raw return type name.
OnlyBeCalledSpecification<CONJUNCTION>	onlyBeCalled()	Asserts that only certain objects call the code units selected by this rule.

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

haveRawParameterTypes

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

Asserts that JavaCodeUnits have the specified raw parameter types.

E.g.

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

would be violated by someMethod in

 class Example {
     void someMethod(Object wrongParam, int intParam) {...}
 }
 

Parameters:

parameterTypes - Parameter types JavaCodeUnits should have

Returns:

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

notHaveRawParameterTypes

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

Asserts that JavaCodeUnits do not have the specified raw parameter types.

E.g.

 codeUnits().should().notHaveRawParameterTypes(String.class, int.class)
 

would be violated by someMethod in

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

Parameters:

parameterTypes - Parameter types JavaCodeUnits should not have

Returns:

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

onlyBeCalled

@PublicAPI(usage=ACCESS)
OnlyBeCalledSpecification<CONJUNCTION> onlyBeCalled()

Asserts that only certain objects call the code units selected by this rule.

E.g.

 codeUnits().should().onlyBeCalled().byClassesThat().belongToAnyOf(SomeClass.class)
 

Returns:

A syntax element that allows restricting how code units can be called

haveRawParameterTypes

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

Asserts that JavaCodeUnits have the specified fully qualified raw parameter type names.

E.g.

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

would be violated by someMethod in

 class Example {
     void someMethod(Object wrongParam, int intParam) {...}
 }
 

Parameters:

parameterTypeNames - Fully qualified names of parameter types JavaCodeUnits should have

Returns:

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

notHaveRawParameterTypes

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

Asserts that JavaCodeUnits do not have the specified fully qualified raw parameter type names.

E.g.

 codeUnits().should().notHaveRawParameterTypes(String.class.getName(), int.class.getName())
 

would be violated by someMethod in

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

Parameters:

parameterTypeNames - Fully qualified names of parameter types JavaCodeUnits should 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)

Asserts that JavaCodeUnits have raw parameter types matching the given predicate.

E.g.

 codeUnits().should().haveRawParameterTypes(whereFirstTypeIs(String.class))
 

would be violated by someMethod in

 class Example {
     void someMethod(Object wrongParam, int intParam) {...}
 }
 

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

notHaveRawParameterTypes

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

Asserts that JavaCodeUnits do not have raw parameter types matching the given predicate.

E.g.

 codeUnits().should().notHaveRawParameterTypes(whereFirstTypeIs(String.class))
 

would be violated by someMethod in

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

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)

Asserts that JavaCodeUnits have the specified raw return type.

E.g.

 codeUnits().should().haveRawReturnType(String.class)
 

would be violated by someMethod in

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

Parameters:

type - Return type JavaCodeUnits should have

Returns:

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

notHaveRawReturnType

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

Asserts that JavaCodeUnits do not have the specified raw return type.

E.g.

 codeUnits().should().notHaveRawReturnType(String.class)
 

would be violated by someMethod in

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

Parameters:

type - Return type JavaCodeUnits should not have

Returns:

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

haveRawReturnType

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

Asserts that JavaCodeUnits have the specified fully qualified raw return type name.

E.g.

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

would be violated by someMethod in

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

Parameters:

typeName - Fully qualified name of a return type JavaCodeUnits should have

Returns:

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

notHaveRawReturnType

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

Asserts that JavaCodeUnits do not have the specified fully qualified raw return type name.

E.g.

 codeUnits().should().notHaveRawReturnType(String.class.getName())
 

would be violated by someMethod in

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

Parameters:

typeName - Fully qualified name of a return type JavaCodeUnits should 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)

Asserts that JavaCodeUnits have raw return types matching the given predicate.

E.g.

 codeUnits().should().haveRawReturnType(assignableTo(Serializable.class))
 

would be violated by someMethod in

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

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

notHaveRawReturnType

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

Asserts that JavaCodeUnits do not have raw return types matching the given predicate.

E.g.

 codeUnits().should().notHaveRawReturnType(assignableTo(Serializable.class))
 

would be violated by someMethod in

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

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)

Asserts that JavaCodeUnits declare a Throwable of the specified type in their throws clause.

E.g.

 codeUnits().should().declareThrowableOfType(SomeException.class)
 

would be violated by someMethod in

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

Parameters:

type - Type of a declared Throwable JavaCodeUnits should have

Returns:

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

notDeclareThrowableOfType

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

Asserts that JavaCodeUnits do not declare a Throwable of the specified type in their throws clause.

E.g.

 codeUnits().should().notDeclareThrowableOfType(SomeException.class)
 

would be violated by someMethod in

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

Parameters:

type - Type of a declared Throwable JavaCodeUnits should not have

Returns:

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

declareThrowableOfType

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

Asserts that JavaCodeUnits declare a Throwable of the specified fully qualified type name in their throws clause.

E.g.

 codeUnits().should().declareThrowableOfType(SomeException.class.getName())
 

would be violated by someMethod in

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

Parameters:

typeName - Fully qualified name of a type of a declared Throwable JavaCodeUnits should have

Returns:

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

notDeclareThrowableOfType

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

Asserts that JavaCodeUnits do not declare a Throwable of the specified fully qualified type name in their throws clause.

E.g.

 codeUnits().should().notDeclareThrowableOfType(SomeException.class.getName())
 

would be violated by someMethod in

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

Parameters:

typeName - Fully qualified name of a type of a declared Throwable JavaCodeUnits should 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)

Asserts that JavaCodeUnits declare a Throwable which matches the given predicate.

E.g.

 codeUnits().should().declareThrowableOfType(nameStartingWith("Some"))
 

would be violated by someMethod in

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

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

notDeclareThrowableOfType

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

Asserts that JavaCodeUnits do not declare a Throwable which matches the given predicate.

E.g.

 codeUnits().should().notDeclareThrowableOfType(nameStartingWith("Some"))
 

would be violated by someMethod in

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

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