Uses of Class
com.puppycrawl.tools.checkstyle.api.FileText

Packages that use FileText

Package	Description
com.puppycrawl.tools.checkstyle	Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api	Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks	Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.header	File Header checks.
com.puppycrawl.tools.checkstyle.checks.javadoc	Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.regexp	Contains the regular expression checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.sizes	Contains the Size Violations checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.whitespace	Contains the Whitespace checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filters	Contains the filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.gui	User interface classes for CheckStyle.
com.puppycrawl.tools.checkstyle.xpath	Contains the nodes implementations for XPATH queries and query generator.

Uses of FileText in com.puppycrawl.tools.checkstyle

Methods in com.puppycrawl.tools.checkstyle with parameters of type FileText

Modifier and Type	Method	Description
private static String	SuppressionsStringPrinter.generate(FileText fileText, DetailAST detailAST, int lineNumber, int columnNumber, int tabWidth)	Creates XpathQueryGenerator instance and generates suppressions.
static DetailAST	JavaParser.parseFileText(FileText text, JavaParser.Options options)	Parse a text and return the parse tree.
static String	AstTreeStringPrinter.printAst(FileText text, JavaParser.Options options)	Parse a file and print the parse tree.
protected void	TreeWalker.processFiltered(File file, FileText fileText)	Called to process a file that matches the specified file extensions.

Uses of FileText in com.puppycrawl.tools.checkstyle.api

Fields in com.puppycrawl.tools.checkstyle.api declared as FileText

Modifier and Type	Field	Description
private final FileText	FileContents.text	The text.

Methods in com.puppycrawl.tools.checkstyle.api that return FileText

Modifier and Type	Method	Description
FileText	FileContents.getText()	Get the full text of the file.

Methods in com.puppycrawl.tools.checkstyle.api with parameters of type FileText

Modifier and Type	Method	Description
final SortedSet<Violation>	AbstractFileSetCheck.process(File file, FileText fileText)
SortedSet<Violation>	FileSetCheck.process(File file, FileText fileText)	Request to process a file.
protected abstract void	AbstractFileSetCheck.processFiltered(File file, FileText fileText)	Called to process a file that matches the specified file extensions.

Constructors in com.puppycrawl.tools.checkstyle.api with parameters of type FileText

Modifier	Constructor	Description
	FileContents(FileText text)	Creates a new FileContents instance.
	FileText(FileText fileText)	Copy constructor.

Uses of FileText in com.puppycrawl.tools.checkstyle.checks

Methods in com.puppycrawl.tools.checkstyle.checks with parameters of type FileText

Modifier and Type	Method	Description
private static int	OrderedPropertiesCheck.getIndex(int startLineNo, FileText fileText, String keyName)	Inner method to get the index number of the position of keyName.
private static int	OrderedPropertiesCheck.getLineNumber(int startLineNo, FileText fileText, String previousProp, String propKey)	Method returns the index number where the key is detected (starting at 0).
private static int	UniquePropertiesCheck.getLineNumber(FileText fileText, String keyName)	Method returns line number the key is detected in the checked properties files first.
protected void	NewlineAtEndOfFileCheck.processFiltered(File file, FileText fileText)
protected void	OrderedPropertiesCheck.processFiltered(File file, FileText fileText)	Processes the file and check order.
protected void	TranslationCheck.processFiltered(File file, FileText fileText)
protected void	UniquePropertiesCheck.processFiltered(File file, FileText fileText)

Uses of FileText in com.puppycrawl.tools.checkstyle.checks.header

Methods in com.puppycrawl.tools.checkstyle.checks.header with parameters of type FileText

Modifier and Type	Method	Description
private static MultiFileRegexpHeaderCheck.MatchResult	MultiFileRegexpHeaderCheck.createMismatchResult(MultiFileRegexpHeaderCheck.HeaderFileMetadata headerFile, FileText fileText, int mismatchLine)	Creates a MatchResult for a mismatch case.
private static MultiFileRegexpHeaderCheck.MatchResult	MultiFileRegexpHeaderCheck.matchHeader(FileText fileText, MultiFileRegexpHeaderCheck.HeaderFileMetadata headerFile)	Analyzes if the file text matches the header file patterns and generates a detailed result.
protected void	HeaderCheck.processFiltered(File file, FileText fileText)
protected void	MultiFileRegexpHeaderCheck.processFiltered(File file, FileText fileText)
protected void	RegexpHeaderCheck.processFiltered(File file, FileText fileText)

Uses of FileText in com.puppycrawl.tools.checkstyle.checks.javadoc

Methods in com.puppycrawl.tools.checkstyle.checks.javadoc with parameters of type FileText

Modifier and Type	Method	Description
protected void	JavadocPackageCheck.processFiltered(File file, FileText fileText)

Uses of FileText in com.puppycrawl.tools.checkstyle.checks.regexp

Fields in com.puppycrawl.tools.checkstyle.checks.regexp declared as FileText

Modifier and Type	Field	Description
private FileText	MultilineDetector.text	The file text content.

Methods in com.puppycrawl.tools.checkstyle.checks.regexp with parameters of type FileText

Modifier and Type	Method	Description
private boolean	RegexpCheck.isIgnore(int startLine, FileText text, LineColumn start, Matcher matcher)	Detect ignore situation.
protected void	RegexpMultilineCheck.processFiltered(File file, FileText fileText)
protected void	RegexpOnFilenameCheck.processFiltered(File file, FileText fileText)
protected void	RegexpSinglelineCheck.processFiltered(File file, FileText fileText)
void	MultilineDetector.processLines(FileText fileText)	Processes an entire text file looking for matches.
void	SinglelineDetector.processLines(FileText fileText)	Processes a set of lines looking for matches.

Uses of FileText in com.puppycrawl.tools.checkstyle.checks.sizes

Methods in com.puppycrawl.tools.checkstyle.checks.sizes with parameters of type FileText

Modifier and Type	Method	Description
protected void	FileLengthCheck.processFiltered(File file, FileText fileText)
protected void	LineLengthCheck.processFiltered(File file, FileText fileText)

Uses of FileText in com.puppycrawl.tools.checkstyle.checks.whitespace

Methods in com.puppycrawl.tools.checkstyle.checks.whitespace with parameters of type FileText

Modifier and Type	Method	Description
protected void	FileTabCharacterCheck.processFiltered(File file, FileText fileText)

Uses of FileText in com.puppycrawl.tools.checkstyle.filters

Methods in com.puppycrawl.tools.checkstyle.filters that return FileText

Modifier and Type	Method	Description
private static FileText	SuppressWithNearbyTextFilter.getFileText(String fileName)	Returns FileText instance created based on the given file name.
private static FileText	SuppressWithPlainTextCommentFilter.getFileText(String fileName)	Caches FileText instance created based on the given file name.

Methods in com.puppycrawl.tools.checkstyle.filters with parameters of type FileText

Modifier and Type	Method	Description
private void	SuppressWithPlainTextCommentFilter.cacheSuppressions(FileText fileText)	Collects the list of SuppressWithPlainTextCommentFilter.Suppression instances retrieved from the given FileText.
private void	SuppressWithNearbyTextFilter.collectSuppressions(FileText fileText)	Collets all SuppressWithNearbyTextFilter.Suppression instances retrieved from the given FileText.
private SuppressWithNearbyTextFilter.Suppression	SuppressWithNearbyTextFilter.getSuppression(FileText fileText, int lineNo)	Tries to extract the suppression from the given line.
private Optional<SuppressWithPlainTextCommentFilter.Suppression>	SuppressWithPlainTextCommentFilter.getSuppression(FileText fileText, int lineNo)	Tries to extract the suppression from the given line.

Uses of FileText in com.puppycrawl.tools.checkstyle.gui

Methods in com.puppycrawl.tools.checkstyle.gui that return FileText

Modifier and Type	Method	Description
private static FileText	MainFrameModel.getFileText(File file)	Get FileText from a file.

Uses of FileText in com.puppycrawl.tools.checkstyle.xpath

Fields in com.puppycrawl.tools.checkstyle.xpath declared as FileText

Modifier and Type	Field	Description
private final FileText	XpathQueryGenerator.fileText	The FileText object, representing content of the file.

Constructors in com.puppycrawl.tools.checkstyle.xpath with parameters of type FileText

Modifier	Constructor	Description
	XpathQueryGenerator(DetailAST rootAst, int lineNumber, int columnNumber, int tokenType, FileText fileText, int tabWidth)	Creates a new XpathQueryGenerator instance.
	XpathQueryGenerator(DetailAST rootAst, int lineNumber, int columnNumber, FileText fileText, int tabWidth)	Creates a new XpathQueryGenerator instance.