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

Class Annotation

Any annotation used to annotate language elements with meta-information.

Import path

import java

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

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

getAStringArrayValue

Gets a value of the annotation element with the specified name, which must be declared as a string array. This includes default values in case no explicit value is specified.

getATypeArrayValue

Gets a value of the annotation element with the specified name, which must be declared as a Class array. This includes default values in case no explicit value is specified.

getAnArrayValue

Gets a value of the annotation element with the specified name, which must be declared as an array type. This includes default values in case no explicit value is specified.

getAnEnumConstantArrayValue

Gets a value of the annotation element with the specified name, which must be declared as an enum type array. This includes default values in case no explicit value is specified.

getAnIntArrayValue

Gets a value of the annotation element with the specified name, which must be declared as an int array or an array of a smaller integral type or char. This includes default values in case no explicit value is specified.

getAnnotatedElement

Gets the element being annotated.

getAnnotationElement

Gets the annotation element with the specified name.

getArrayValue

Gets the value at a given index of the annotation element with the specified name, which must be declared as an array type. This includes default values in case no explicit value is specified.

getBooleanValue

If the value type of the annotation element with the specified name is boolean, gets the boolean value used for that element. This includes default values in case no explicit value is specified.

getEnumConstantValue

If the value type of the annotation element with the specified name is an enum type, gets the enum constant used as value for that element. This includes default values in case no explicit value is specified.

getHalsteadID

This expression’s Halstead ID (used to compute Halstead metrics).

getIntValue

If the value type of the annotation element with the specified name is int or a smaller integral type or char, gets the int value used for that element. This includes default values in case no explicit value is specified.

getStringValue

If the value type of the annotation element with the specified name is String, gets the string value used for that element. This includes default values in case no explicit value is specified.

getTarget

Gets the element being annotated.

getType

Gets the annotation type declaration for this annotation.

getTypeValue

If the value type of the annotation element with the specified name is java.lang.Class, gets the type referred to by that Class. This includes default values in case no explicit value is specified.

getValue

Gets the value of the annotation element with the specified name. This includes default values in case no explicit value is specified. For elements with an array value type this might get an ArrayInit instance. To properly handle array values, prefer the predicate getAnArrayValue.

isDeclAnnotation

Holds if this annotation applies to a declaration.

isTypeAnnotation

Holds if this annotation applies to a type.

toString

Gets a textual representation of this element.

Inherited predicates

getAChildExpr

Gets a child of this expression.

from Expr
getAnEnclosingStmt

Gets a statement that directly or transitively contains this expression, if any. This is equivalent to this.getEnclosingStmt().getEnclosingStmt*().

from Expr
getBasicBlock

Gets the basic block in which this expression occurs, if any.

from Expr
getCompilationUnit

Gets the compilation unit in which this expression occurs.

from Expr
getControlFlowNode

Gets the ControlFlowNode corresponding to this expression.

from Expr
getEnclosingCallable

Gets the callable in which this expression occurs, if any.

from Expr
getEnclosingStmt

Gets the statement containing this expression, if any.

from Expr
getFile

Gets the file associated with this element.

from Top
getIndex

Gets the index of this expression as a child of its parent.

from Expr
getKind

Gets the kind of this expression.

from Expr
getKotlinType

Gets the Kotlin type of this expression.

from Expr
getLocation

Gets the source location for this element.

from Top
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
getParent

Gets the parent of this expression.

from Expr
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
getUnderlyingExpr

Gets the underlying expression looking through casts and not-nulls, if any. Otherwise just gets this expression.

from Expr
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
isCompileTimeConstant

Holds if this expression is a compile-time constant.

from Expr
isInStaticContext

Holds if this expression occurs in a static context.

from Expr
isNthChildOf

Holds if this expression is the child of the specified parent at the specified (zero-based) position.

from Expr
isParenthesized

Holds if this expression is parenthesized.

from Expr