CodeQL library for Java/Kotlin
codeql/java-all 0.8.11-dev (changelog, source)
Search

Class Annotatable

An abstract representation of language elements that can be annotated.

Import path

import java

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getADeclaredAnnotation

Gets an annotation that is declared on this element, excluding inherited annotations. The retention policy of the annotation type is not considered.

getAnAnnotation

Gets an annotation that applies to this element, including inherited annotations. The results only include direct annotations; indirect annotations, that is repeated annotations in an (implicit) container annotation, are not included. The retention policy of the annotation type is not considered.

getAnAssociatedAnnotation

Gets an annotation associated with this element, that is: - An annotation directly present on this element, or - An annotation indirectly present on this element (in the form of a repeated annotation), or - If an annotation of a type is neither directly nor indirectly present the result is an associated inherited annotation (recursively)

hasAnnotation

Holds if this element has an annotation, including inherited annotations. The retention policy of the annotation type is not considered.

hasAnnotation

Holds if this element has the specified annotation, including inherited annotations. The retention policy of the annotation type is not considered.

hasDeclaredAnnotation

Holds if this element has a declared annotation, excluding inherited annotations. The retention policy of the annotation type is not considered.

suppressesWarningsAbout

Holds if this or any enclosing Annotatable has a @SuppressWarnings("<category>") annotation attached to it for the specified category.

Inherited predicates

compilerGeneratedReason

Gets the reason this element was generated by the compiler, if any.

from Element
contains

Holds if this element transitively contains the specified element e.

from Element
fromSource

Holds if this element pertains to a source file.

from Element
getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

from Top
getCompilationUnit

Gets the compilation unit that this element belongs to.

from Element
getDoc

Cast this element to a Documentable.

from Element
getFile

Gets the file associated with this element.

from Top
getLocation

Gets the source location for this element.

from Top
getName

Gets the name of this element.

from Element
getNumberOfCommentLines

Gets the number of comment lines that this element ranges over.

from Top
getNumberOfLinesOfCode

Gets the number of lines of code that this element ranges over.

from Top
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Top
getTotalNumberOfLines

Gets the total number of lines that this element ranges over, including lines of code, comment and whitespace-only lines.

from Top
hasChildElement

Holds if this element is the immediate parent of the specified element e.

from Element
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

from Top
hasName

Holds if this element has the specified name.

from Element
isCompilerGenerated

Holds if this is an auxiliary program element generated by the compiler.

from Element
toString

Gets a textual representation of this element.

from Top