Class File::Container

A file or folder.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAChildContainer

Gets a file or sub-folder in this container.

getAFile

Gets a file in this container.

getAFolder

Gets a sub-folder in this container.

getAbsolutePath

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

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.

getExtension

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

getFile

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

getFolder

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

getParentContainer

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

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.

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.

getURL

DEPRECATED: Use getLocation instead. Gets a URL representing the location of this container.

toString

Gets a textual representation of the path of this container.

Inherited predicates

findRootCause

Gets the source of this element: either itself or a macro that expanded to this element.

from Element
fromLibrary

Holds if this element may be from a library.

from Element
fromSource

Holds if this element may be from source.

from Element
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getFile

Gets the primary file where this element occurs.

from Element
getLocation

Gets the primary location of this element.

from Element
getParentScope

Gets the parent scope of this Element, if any. A scope is a Type (Class / Enum), a Namespace, a Block, a Function, or certain kinds of Statement.

from Element
isAffectedByMacro

Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of isInMacroExpansion.

from Element
isFromTemplateInstantiation

Holds if this Element is a part of a template instantiation (but not the template itself).

from Element
isFromUninstantiatedTemplate

Holds if this Element is part of a template template (not if it is part of an instantiation of template). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.

from Element
isInMacroExpansion

Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see isAffectedByMacro.

from Element