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

Class File

A file.

Note that File extends Container as it may be a jar file.

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.

isJavaSourceFile

Holds if this is a Java source file.

isKotlinSourceFile

Holds if this is a Kotlin source file.

isSourceFile

Holds if this is a (Java or Kotlin) source file.

Inherited predicates

getAChildContainer

Gets a file or sub-folder in this container.

from Container
getAFile

Gets a file in this container.

from Container
getAFolder

Gets a sub-folder in this container.

from Container
getAbsolutePath

Gets the absolute, canonical path of this container, using forward slashes as path separator.

from Container
getBaseName

Gets the base name of this container including extension, that is, the last segment of its absolute path, or the empty string if it has no segments.

from Container
getExtension

Gets the extension of this container, that is, the suffix of its base name after the last dot character, if any.

from Container
getFile

Gets the file in this container that has the given baseName, if any.

from Container
getFile

Gets the file associated with this element.

from Top
getFolder

Gets the sub-folder in this container that has the given baseName, if any.

from Container
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
getParentContainer

Gets the parent container of this file or folder, if any.

from Container
getPrimaryQlClasses

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

from Top
getRelativePath

Gets the relative path of this file or folder from the root folder of the analyzed source location. The relative path of the root folder itself is the empty string.

from Container
getStem

Gets the stem of this container, that is, the prefix of its base name up to (but not including) the last dot character if there is one, or the entire base name if there is not.

from Container
getTotalNumberOfLines

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

from Top
getURL

Gets the URL of this file.

from File
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
toStringfrom Container