Class XML::XMLFile

An XML file.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getADTD

Gets a DTD associated with this XML file.

getARootElement

Gets a top-most element in an XML file.

getEncoding

Gets the encoding of this XML file.

getFile

Gets the XML file itself.

getName

Gets the name of this XML file.

toString

Gets a printable representation of this XML file.

Inherited predicates

allCharactersString

Append all the character sequences of this XML parent from left to right, separated by a space.

from XMLParent
charsSetUpTo

DEPRECATED: Internal.

from XMLParent
getACharactersSet

Gets a character sequence that is a child of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent with the given name.

from XMLParent
getAChildContainer

Gets a file or sub-folder in this container.

from Container
getAComment

Gets a comment that is a child of this XML parent.

from XMLParent
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 File
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
getChild

Gets the child element at a specified index of this XML parent.

from XMLParent
getDepth

Gets the depth in the tree. (Overridden in XMLElement.)

from XMLParent
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
getFolder

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

from Container
getFullName

DEPRECATED: use getAbsolutePath() instead.

from Container
getLocation

Gets the source location for this element.

from Top
getNumberOfCharacterSets

Gets the number of places in the body of this XML parent where text occurs.

from XMLParent
getNumberOfChildren

Gets the number of child XML elements of this XML parent.

from XMLParent
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
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
getShortName

DEPRECATED: use getBaseName() or getStem() instead.

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
getTextValue

Gets the text value contained in this XML parent.

from XMLParent
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 LGTM locations.

from Top
hasName

DEPRECATED: use getAbsolutePath(), getBaseName() or getStem() instead.

from File

Charpred