Package com.tngtech.archunit.core.domain

Class JavaField

java.lang.Object

com.tngtech.archunit.core.domain.JavaMember

com.tngtech.archunit.core.domain.JavaField

All Implemented Interfaces:

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

@PublicAPI(usage=ACCESS)
public final class JavaField
extends JavaMember
implements HasType

Nested Class Summary

Nested classes/interfaces inherited from class com.tngtech.archunit.core.domain.JavaMember

JavaMember.Predicates

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

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

HasType.Functions, HasType.Predicates

Method Summary

Modifier and Type	Method	Description
Set<JavaFieldAccess>	getAccessesToSelf()
Set<JavaClass>	getAllInvolvedRawTypes()	Similar to JavaType.getAllInvolvedRawTypes(), this method returns all raw types involved in this member's signature.
JavaAnnotation<JavaField>	getAnnotationOfType(String typeName)
Set<JavaAnnotation<JavaField>>	getAnnotations()
String	getDescription()
String	getFullName()
JavaClass	getRawType()
JavaType	getType()
Field	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.
Optional<JavaAnnotation<JavaField>>	tryGetAnnotationOfType(String typeName)

Methods inherited from class com.tngtech.archunit.core.domain.JavaMember

getAnnotationOfType, getDescriptor, getModifiers, getName, getOwner, getReverseDependencies, getSourceCodeLocation, isAnnotatedWith, isAnnotatedWith, isAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, toString, tryGetAnnotationOfType

Methods inherited from class java.lang.Object

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

Method Details

getFullName

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

Specified by:

getFullName in interface HasName.AndFullName

Returns:

The full name of this JavaField, i.e. a string containing ${declaringClass}.${name}

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()

getAllInvolvedRawTypes

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

Description copied from class: JavaMember

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

Specified by:

getAllInvolvedRawTypes in class JavaMember

Returns:

All raw types involved in this field's signature, which is equivalent to getType().getAllInvolvedRawTypes().

getAccessesToSelf

@PublicAPI(usage=ACCESS)
public Set<JavaFieldAccess> getAccessesToSelf()

Specified by:

getAccessesToSelf in class JavaMember

getAnnotations

public Set<JavaAnnotation<JavaField>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaMember>

Overrides:

getAnnotations in class JavaMember

getAnnotationOfType

public JavaAnnotation<JavaField> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

getAnnotationOfType in class 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

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

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

tryGetAnnotationOfType in class 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)

reflect

@PublicAPI(usage=ACCESS)
public Field reflect()

Description copied from class: JavaMember

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.

Specified by:

reflect in class JavaMember

Returns:

The Member equivalent to this JavaMember

getDescription

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

Specified by:

getDescription in interface HasDescription