Package com.tngtech.archunit.core.domain

Class JavaParameter

java.lang.Object

com.tngtech.archunit.core.domain.JavaParameter

All Implemented Interfaces:

HasDescription, CanBeAnnotated, HasAnnotations<JavaParameter>, HasOwner<JavaCodeUnit>, HasType

@PublicAPI(usage=ACCESS)
public final class JavaParameter
extends Object
implements HasType, HasOwner<JavaCodeUnit>, HasAnnotations<JavaParameter>

A parameter of a JavaCodeUnit, i.e. encapsulates the raw parameter type, the (possibly) generic parameter type and any annotations this parameter has.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.CanBeAnnotated

CanBeAnnotated.Predicates, CanBeAnnotated.Utils

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasOwner

HasOwner.Functions, HasOwner.Predicates

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasType

HasType.Functions, HasType.Predicates

Method Summary

Modifier and Type	Method	Description
<A extends Annotation> A	getAnnotationOfType(Class<A> type)
JavaAnnotation<JavaParameter>	getAnnotationOfType(String typeName)
Set<JavaAnnotation<JavaParameter>>	getAnnotations()
String	getDescription()
int	getIndex()
JavaCodeUnit	getOwner()
JavaClass	getRawType()
JavaType	getType()
boolean	isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)	Returns true, if this element is annotated with an annotation matching the given predicate.
boolean	isAnnotatedWith(Class<? extends Annotation> annotationType)	Returns true, if this element is annotated with the given annotation type.
boolean	isAnnotatedWith(String annotationTypeName)
boolean	isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)	Returns true, if this element is meta-annotated with an annotation matching the given predicate.
boolean	isMetaAnnotatedWith(Class<? extends Annotation> annotationType)	Returns true, if this element is meta-annotated with the given annotation type.
boolean	isMetaAnnotatedWith(String annotationTypeName)
String	toString()
<A extends Annotation> Optional<A>	tryGetAnnotationOfType(Class<A> type)
Optional<JavaAnnotation<JavaParameter>>	tryGetAnnotationOfType(String typeName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getOwner

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getOwner()

Specified by:

getOwner in interface HasOwner<JavaCodeUnit>

Returns:

The "owner" of this object, compare HasOwner

getIndex

@PublicAPI(usage=ACCESS)
public int getIndex()

getType

@PublicAPI(usage=ACCESS)
public JavaType getType()

Specified by:

getType in interface HasType

Returns:

The (possibly generic) JavaType of this object. Refer to the documentation of JavaType for further information.

See Also:

• HasType.getRawType()

getRawType

@PublicAPI(usage=ACCESS)
public JavaClass getRawType()

Specified by:

getRawType in interface HasType

Returns:

The raw type of this object. This is effectively the same as calling HasType.getType().toErasure(). E.g. given a JavaParameterizedType java.util.List<String> the raw type (i.e. type erasure) would be the JavaClass java.util.List.

See Also:

• HasType.getType()

isAnnotatedWith

public boolean isAnnotatedWith(Class<? extends Annotation> annotationType)

Description copied from interface: CanBeAnnotated

Returns true, if this element is annotated with the given annotation type.

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationType - The type of the annotation to check for

isAnnotatedWith

public boolean isAnnotatedWith(String annotationTypeName)

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationTypeName - Fully qualified class name of a specific type of Annotation

See Also:

• CanBeAnnotated.isAnnotatedWith(Class)

isAnnotatedWith

public boolean isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)

Description copied from interface: CanBeAnnotated

Returns true, if this element is annotated with an annotation matching the given predicate.

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

predicate - Qualifies matching annotations

isMetaAnnotatedWith

public boolean isMetaAnnotatedWith(Class<? extends Annotation> annotationType)

Description copied from interface: CanBeAnnotated

Returns true, if this element is meta-annotated with the given annotation type. A meta-annotation is an annotation that is declared on another annotation.

This method also returns true if this element is directly annotated with the given annotation type.

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationType - The type of the annotation to check for

isMetaAnnotatedWith

public boolean isMetaAnnotatedWith(String annotationTypeName)

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationTypeName - Fully qualified class name of a specific type of Annotation

See Also:

• CanBeAnnotated.isMetaAnnotatedWith(Class)

isMetaAnnotatedWith

public boolean isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)

Description copied from interface: CanBeAnnotated

Returns true, if this element is meta-annotated with an annotation matching the given predicate. A meta-annotation is an annotation that is declared on another annotation.

This method also returns true if this element is directly annotated with an annotation matching the given predicate.

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

predicate - Qualifies matching annotations

getAnnotations

public Set<JavaAnnotation<JavaParameter>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaParameter>

getAnnotationOfType

public <A extends Annotation> A getAnnotationOfType(Class<A> type)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaParameter>

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - The Class of the Annotation to retrieve.

Returns:

The Annotation of the given type. Will throw an IllegalArgumentException if no matching Annotation is present.

See Also:

• HasAnnotations.tryGetAnnotationOfType(Class)
• HasAnnotations.getAnnotationOfType(String)

getAnnotationOfType

public JavaAnnotation<JavaParameter> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaParameter>

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type. Will throw an IllegalArgumentException if no matching Annotation is present.

See Also:

• HasAnnotations.tryGetAnnotationOfType(String)
• HasAnnotations.getAnnotationOfType(Class)

tryGetAnnotationOfType

public <A extends Annotation> Optional<A> tryGetAnnotationOfType(Class<A> type)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaParameter>

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - The Class of the Annotation to retrieve.

Returns:

The Annotation of the given type or Optional.empty() if there is no Annotation with the respective annotation type.

See Also:

• HasAnnotations.getAnnotationOfType(Class)
• HasAnnotations.tryGetAnnotationOfType(String)

tryGetAnnotationOfType

public Optional<JavaAnnotation<JavaParameter>> tryGetAnnotationOfType(String typeName)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaParameter>

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type or Optional.empty() if there is no Annotation with the respective annotation type.

See Also:

• HasAnnotations.getAnnotationOfType(String)
• HasAnnotations.tryGetAnnotationOfType(Class)

getDescription

@PublicAPI(usage=ACCESS)
public String getDescription()

Specified by:

getDescription in interface HasDescription

toString

public String toString()

Overrides:

toString in class Object