Package org.sonar.plugins.java.api.semantic

Interface SymbolMetadata

public interface SymbolMetadata

Holds the metadata information (annotations) of a symbol.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SymbolMetadata.AnnotationInstance	Occurrence of an annotation on a symbol.
static interface	SymbolMetadata.AnnotationValue	Value of a property of an annotation.
static interface	SymbolMetadata.NullabilityData
static enum	SymbolMetadata.NullabilityLevel
static enum	SymbolMetadata.NullabilityTarget
static enum	SymbolMetadata.NullabilityType

Method Summary

Modifier and Type	Method	Description
List<SymbolMetadata.AnnotationInstance>	annotations()	The list of annotations found on this symbol.
AnnotationTree	findAnnotationTree(SymbolMetadata.AnnotationInstance annotationInstance)
boolean	isAnnotatedWith(String fullyQualifiedName)	Check if the symbol is annotated with the specified annotation.
SymbolMetadata.NullabilityData	nullabilityData()
SymbolMetadata.NullabilityData	nullabilityData(SymbolMetadata.NullabilityTarget level)
List<SymbolMetadata.AnnotationValue>	valuesForAnnotation(String fullyQualifiedNameOfAnnotation)	Get the annotation values for the specified annotation.

Method Details

isAnnotatedWith

boolean isAnnotatedWith(String fullyQualifiedName)

Check if the symbol is annotated with the specified annotation.

Parameters:

fullyQualifiedName - fully Qualified Name of the annotation

Returns:

true if the symbol is annotated with the annotation

valuesForAnnotation

@CheckForNull
List<SymbolMetadata.AnnotationValue> valuesForAnnotation(String fullyQualifiedNameOfAnnotation)

Get the annotation values for the specified annotation.

Parameters:

fullyQualifiedNameOfAnnotation - fully Qualified Name of the annotation

Returns:

null if the annotation is not present, a List otherwise

annotations

List<SymbolMetadata.AnnotationInstance> annotations()

The list of annotations found on this symbol.

Returns:

A list of SymbolMetadata.AnnotationInstance

nullabilityData

SymbolMetadata.NullabilityData nullabilityData()

Returns:

the nullability definition for metadata() of: - fields - method parameters - methods (related to method return values) - local variables And currently always return UNKNOWN_NULLABILITY for unsupported metadata() of: - lambda parameters

nullabilityData

SymbolMetadata.NullabilityData nullabilityData(SymbolMetadata.NullabilityTarget level)

findAnnotationTree

@Nullable
AnnotationTree findAnnotationTree(SymbolMetadata.AnnotationInstance annotationInstance)