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

Class FormattingCall

A call to a StringFormatMethod or a callable wrapping a StringFormatMethod.

Import path

import semmle.code.java.StringFormat

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAFormatString

Gets a FormatString that is used by this call.

getAnArgumentToBeFormatted

Gets an argument to be formatted.

getArgumentToBeFormatted

Gets the ith argument to be formatted. The index i is one-based.

getFormatArgument

Gets the argument to this call in the position of the format string

getSyntax

Gets the format string syntax used by this call.

getVarargsCount

Gets the length of the varargs array if it can determined.

hasTrailingThrowableArgument

Holds if this uses the “logger ({})” format syntax and the last argument is a Throwable.

Inherited predicates

getAPrimaryQlClass

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

from Top
getAnArgument

Gets an argument supplied in this call.

from Call
getArgument

Gets the argument specified at the (zero-based) position in this call.

from Call
getCallee

Gets the target callable of this call.

from Call
getCaller

Gets the callable invoking this call.

from Call
getEnclosingCallable

Gets the immediately enclosing callable that contains this call.

from Call
getEnclosingStmt

Gets the enclosing statement of this call.

from Call
getFile

Gets the file associated with this element.

from Top
getLocation

Gets the source location for this element.

from Top
getNumArgument

Gets the number of arguments provided in this call.

from Call
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
getQualifier

Gets the qualifying expression of this call, if any.

from Call
getTotalNumberOfLines

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

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

Gets a textual representation of this element.

from Top

Charpred