Package com.tngtech.archunit.core.domain

Class JavaMember

java.lang.Object

com.tngtech.archunit.core.domain.JavaMember

All Implemented Interfaces:

HasDescription, CanBeAnnotated, HasAnnotations<JavaMember>, HasDescriptor, HasModifiers, HasName, HasName.AndFullName, HasOwner<JavaClass>, HasSourceCodeLocation

Direct Known Subclasses:

JavaCodeUnit, JavaField

@PublicAPI(usage=ACCESS)
public abstract class JavaMember
extends Object
implements HasName.AndFullName, HasDescriptor, HasAnnotations<JavaMember>, HasModifiers, HasOwner<JavaClass>, HasSourceCodeLocation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JavaMember.Predicates	Predefined predicates targeting JavaMember.

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

CanBeAnnotated.Utils

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

HasName.AndFullName, HasName.Utils

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

HasName.AndFullName.Functions

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

HasOwner.Functions

Method Summary

Modifier and Type	Method	Description
abstract Set<? extends JavaAccess<?>>	getAccessesToSelf()
abstract Set<JavaClass>	getAllInvolvedRawTypes()	Similar to JavaType.getAllInvolvedRawTypes(), this method returns all raw types involved in this member's signature.
<A extends Annotation> A	getAnnotationOfType(Class<A> type)	Returns the Annotation of this member of the given Annotation type.
JavaAnnotation<? extends JavaMember>	getAnnotationOfType(String typeName)
Set<? extends JavaAnnotation<? extends JavaMember>>	getAnnotations()
String	getDescriptor()
Set<JavaModifier>	getModifiers()
String	getName()
JavaClass	getOwner()
protected com.tngtech.archunit.core.domain.ReverseDependencies	getReverseDependencies()
SourceCodeLocation	getSourceCodeLocation()
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> type)	Returns true, if this element is annotated with the given annotation type.
boolean	isAnnotatedWith(String typeName)
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> type)	Returns true, if this element is meta-annotated with the given annotation type.
boolean	isMetaAnnotatedWith(String typeName)
abstract Member	reflect()	Resolves the respective Member from the classpath. NOTE: This method will throw an exception, if the owning Class or any of its dependencies can't be found on the classpath.
String	toString()
<A extends Annotation> Optional<A>	tryGetAnnotationOfType(Class<A> type)
Optional<? extends JavaAnnotation<? extends JavaMember>>	tryGetAnnotationOfType(String typeName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tngtech.archunit.base.HasDescription

getDescription

Methods inherited from interface com.tngtech.archunit.core.domain.properties.HasName.AndFullName

getFullName

Method Details

getAllInvolvedRawTypes

@PublicAPI(usage=ACCESS)
public abstract Set<JavaClass> getAllInvolvedRawTypes()

Similar to JavaType.getAllInvolvedRawTypes(), this method returns all raw types involved in this member's signature. For more concrete details refer to JavaField.getAllInvolvedRawTypes() and JavaCodeUnit.getAllInvolvedRawTypes().

Returns:

All raw types involved in the signature of this member

getAnnotations

@PublicAPI(usage=ACCESS)
public Set<? extends JavaAnnotation<? extends JavaMember>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaMember>

getAnnotationOfType

@PublicAPI(usage=ACCESS)
public <A extends Annotation> A getAnnotationOfType(Class<A> type)

Returns the Annotation of this member of the given Annotation type.

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaMember>

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.

Throws:

IllegalArgumentException - if there is no annotation of the respective reflection type

See Also:

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

getAnnotationOfType

@PublicAPI(usage=ACCESS)
public JavaAnnotation<? extends JavaMember> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaMember>

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

@PublicAPI(usage=ACCESS)
public <A extends Annotation> Optional<A> tryGetAnnotationOfType(Class<A> type)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaMember>

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

@PublicAPI(usage=ACCESS)
public Optional<? extends JavaAnnotation<? extends JavaMember>> tryGetAnnotationOfType(String typeName)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaMember>

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)

isAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isAnnotatedWith(Class<? extends Annotation> type)

Description copied from interface: CanBeAnnotated

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

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

type - The type of the annotation to check for

isAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isAnnotatedWith(String typeName)

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

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

See Also:

• CanBeAnnotated.isAnnotatedWith(Class)

isAnnotatedWith

@PublicAPI(usage=ACCESS)
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

@PublicAPI(usage=ACCESS)
public boolean isMetaAnnotatedWith(Class<? extends Annotation> type)

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:

type - The type of the annotation to check for

isMetaAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isMetaAnnotatedWith(String typeName)

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

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

See Also:

• CanBeAnnotated.isMetaAnnotatedWith(Class)

isMetaAnnotatedWith

@PublicAPI(usage=ACCESS)
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

getOwner

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

Specified by:

getOwner in interface HasOwner<JavaClass>

Returns:

The "owner" of this object, compare HasOwner

getSourceCodeLocation

@PublicAPI(usage=ACCESS)
public SourceCodeLocation getSourceCodeLocation()

Specified by:

getSourceCodeLocation in interface HasSourceCodeLocation

Returns:

The SourceCodeLocation of this object, i.e. how to locate the respective object within the set of source files.

getModifiers

@PublicAPI(usage=ACCESS)
public Set<JavaModifier> getModifiers()

Specified by:

getModifiers in interface HasModifiers

getName

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

Specified by:

getName in interface HasName

getDescriptor

@Internal
public String getDescriptor()

Specified by:

getDescriptor in interface HasDescriptor

getAccessesToSelf

@PublicAPI(usage=ACCESS)
public abstract Set<? extends JavaAccess<?>> getAccessesToSelf()

reflect

@PublicAPI(usage=ACCESS)
public abstract Member reflect()

Resolves the respective Member from the classpath.
NOTE: This method will throw an exception, if the owning Class or any of its dependencies can't be found on the classpath.

Returns:

The Member equivalent to this JavaMember

getReverseDependencies

protected com.tngtech.archunit.core.domain.ReverseDependencies getReverseDependencies()

toString

public String toString()

Overrides:

toString in class Object