Uses of Class
com.puppycrawl.tools.checkstyle.api.FileContents
Packages that use FileContents
Package
Description
Contains the implementation of the Checkstyle framework.
Contains the core API to be used to implement checks.
Contains the regular expression checks that are bundled with the main
distribution.
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 FileContentsModifier and TypeFieldDescriptionprivate final FileContentsTreeWalkerAuditEvent.fileContentsThe file contents.Methods in com.puppycrawl.tools.checkstyle that return FileContentsModifier and TypeMethodDescriptionTreeWalkerAuditEvent.getFileContents()Returns contents of the file.Methods in com.puppycrawl.tools.checkstyle with parameters of type FileContentsModifier and TypeMethodDescriptionTreeWalker.getFilteredViolations(String fileName, FileContents fileContents, DetailAST rootAST) Returns filtered set ofViolation.private voidTreeWalker.notifyBegin(DetailAST rootAST, FileContents contents, TreeWalker.AstState astState) Notify checks that we are about to begin walking a tree.static DetailASTJavaParser.parse(FileContents contents) Static helper method to parses a Java source file.private voidTreeWalker.walk(DetailAST ast, FileContents contents, TreeWalker.AstState astState) Initiates the walk of an AST.Constructors in com.puppycrawl.tools.checkstyle with parameters of type FileContentsModifierConstructorDescriptionTreeWalkerAuditEvent(FileContents fileContents, String fileName, Violation violation, DetailAST rootAst) Creates a newTreeWalkerAuditEventinstance. -
Uses of FileContents in com.puppycrawl.tools.checkstyle.api
Fields in com.puppycrawl.tools.checkstyle.api declared as FileContentsModifier and TypeFieldDescriptionprivate FileContentsAbstractCheck.FileContext.fileContentsThe current file contents.private FileContentsAbstractFileSetCheck.FileContext.fileContentsThe current file contents.Methods in com.puppycrawl.tools.checkstyle.api that return FileContentsModifier and TypeMethodDescriptionfinal FileContentsAbstractCheck.getFileContents()Deprecated.Usage of this method is no longer accepted.protected final FileContentsAbstractFileSetCheck.getFileContents()Returns the file contents associated with the file.Methods in com.puppycrawl.tools.checkstyle.api with parameters of type FileContentsModifier and TypeMethodDescriptionfinal voidAbstractCheck.setFileContents(FileContents contents) Set the file contents associated with the tree.final voidAbstractFileSetCheck.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 FileContentsModifier and TypeFieldDescriptionprivate final FileContentsCommentSuppressor.currentContentsFile contents to check for comments.Constructors in com.puppycrawl.tools.checkstyle.checks.regexp with parameters of type FileContentsModifierConstructorDescription(package private)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 FileContentsModifier and TypeFieldDescriptionprivate WeakReference<FileContents>SuppressionCommentFilter.fileContentsReferenceReferences the current FileContents for this filter.private WeakReference<FileContents>SuppressWithNearbyCommentFilter.fileContentsReferenceReferences the current FileContents for this filter.Methods in com.puppycrawl.tools.checkstyle.filters that return FileContentsModifier and TypeMethodDescriptionprivate FileContentsSuppressionCommentFilter.getFileContents()Returns FileContents for this filter.private FileContentsSuppressWithNearbyCommentFilter.getFileContents()Returns FileContents for this filter.Methods in com.puppycrawl.tools.checkstyle.filters with parameters of type FileContentsModifier and TypeMethodDescriptionprivate voidSuppressionCommentFilter.setFileContents(FileContents fileContents) Set the FileContents for this filter.private voidSuppressWithNearbyCommentFilter.setFileContents(FileContents fileContents) Set the FileContents for this filter.