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

Packages that use FileContents

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.regexp	Contains the regular expression checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filters	Contains the filters that are bundled with the main distribution.

Uses of FileContents in com.puppycrawl.tools.checkstyle

Fields in com.puppycrawl.tools.checkstyle declared as FileContents

Modifier and Type	Field and Description
private FileContents	TreeWalkerAuditEvent.fileContents The file contents.

Methods in com.puppycrawl.tools.checkstyle that return FileContents

Modifier and Type	Method and Description
FileContents	TreeWalkerAuditEvent.getFileContents() Returns contents of the file.

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

Modifier and Type	Method and Description
private java.util.SortedSet<Violation>	TreeWalker.getFilteredViolations(java.lang.String fileName, FileContents fileContents, DetailAST rootAST) Returns filtered set of Violation.
private void	TreeWalker.notifyBegin(DetailAST rootAST, FileContents contents, TreeWalker.AstState astState) Notify checks that we are about to begin walking a tree.
static DetailAST	JavaParser.parse(FileContents contents) Static helper method to parses a Java source file.
private void	TreeWalker.walk(DetailAST ast, FileContents contents, TreeWalker.AstState astState) Initiates the walk of an AST.

Constructors in com.puppycrawl.tools.checkstyle with parameters of type FileContents

Constructor and Description
TreeWalkerAuditEvent(FileContents fileContents, java.lang.String fileName, Violation violation, DetailAST rootAst) Creates a new TreeWalkerAuditEvent instance.

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

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

Modifier and Type	Field and Description
private FileContents	AbstractCheck.FileContext.fileContents The current file contents.
private FileContents	AbstractFileSetCheck.FileContext.fileContents The current file contents.

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

Modifier and Type	Method and Description
FileContents	AbstractCheck.getFileContents() Deprecated. Usage of this method is no longer accepted. Please use AST based methods instead.
protected FileContents	AbstractFileSetCheck.getFileContents() Returns the file contents associated with the file.

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

Modifier and Type	Method and Description
void	AbstractCheck.setFileContents(FileContents contents) Set the file contents associated with the tree.
void	AbstractFileSetCheck.setFileContents(FileContents contents) Set the file contents associated with the tree.

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

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

Modifier and Type	Field and Description
private FileContents	CommentSuppressor.currentContents File contents to check for comments.

Constructors in com.puppycrawl.tools.checkstyle.checks.regexp with parameters of type FileContents

Constructor and Description
CommentSuppressor(FileContents currentContents) Constructor for this suppressor.

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

Fields in com.puppycrawl.tools.checkstyle.filters with type parameters of type FileContents

Modifier and Type	Field and Description
private java.lang.ref.WeakReference<FileContents>	SuppressWithNearbyCommentFilter.fileContentsReference References the current FileContents for this filter.
private java.lang.ref.WeakReference<FileContents>	SuppressionCommentFilter.fileContentsReference References the current FileContents for this filter.

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

Modifier and Type	Method and Description
private FileContents	SuppressWithNearbyCommentFilter.getFileContents() Returns FileContents for this filter.
private FileContents	SuppressionCommentFilter.getFileContents() Returns FileContents for this filter.

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

Modifier and Type	Method and Description
void	SuppressWithNearbyCommentFilter.setFileContents(FileContents fileContents) Set the FileContents for this filter.
void	SuppressionCommentFilter.setFileContents(FileContents fileContents) Set the FileContents for this filter.