Package net.sourceforge.pmd.lang.document

package net.sourceforge.pmd.lang.document

Contains types to model text files and handle operations on text. Parser implementations build upon this framework. This package is built around the type TextFile, which represents a source file and allows reading and writing. The class TextDocument models an in-memory snapshot of the state of a TextFile, and exposes information like line/offset mapping.

See Also:

• TextFile
• TextDocument
• Reportable

Related Packages

Package	Description
net.sourceforge.pmd.lang
net.sourceforge.pmd.lang.ast
net.sourceforge.pmd.lang.impl
net.sourceforge.pmd.lang.metrics	Language-independent framework to represent code metrics.
net.sourceforge.pmd.lang.rule	Contains Rule and RuleSet related classes.
net.sourceforge.pmd.lang.symboltable

Class	Description
Chars	View on a string which doesn't copy the array for subsequence operations.
FileCollector	Collects files to analyse before a PMD run.
FileId	An identifier for a TextFile.
FileLocation	Represents the coordinates of a text region, used for reporting.
FragmentedDocBuilder
InternalApiBridge	Internal API.
ReadOnlyFileException	Thrown when an attempt to write through a TextFile fails because the file is read-only.
TextDocument	Represents a textual document, providing methods to edit it incrementally and address regions of text.
TextFile	Represents some location containing character data.
TextFileBuilder	A builder for a new text file.
TextFileContent	Contents of a text file.
TextPos2d	A place in a text document, represented as line/column information.
TextRange2d	A place in a text document, represented as line/column information.
TextRegion	A contiguous range of text in a TextDocument.