com.puppycrawl.tools.checkstyle.checks
Class FileContentsHolder
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.FileContentsHolder
- All Implemented Interfaces:
- Configurable, Contextualizable
- public class FileContentsHolder
- extends Check
Holds the current file contents for global access when configured
as a TreeWalker sub-module. For example,
a filter can access the current file contents through this module.
- Author:
- Mike McMahon, Rick Giles
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FileContentsHolder
public FileContentsHolder()
getContents
public static FileContents getContents()
- Returns:
- the current file contents.
getDefaultTokens
public int[] getDefaultTokens()
- Description copied from class:
Check
- Returns the default token a check is interested in. Only used if the
configuration for a check does not define the tokens.
- Specified by:
getDefaultTokens
in class Check
- Returns:
- the default tokens
- See Also:
Check.getDefaultTokens()
beginTree
public void beginTree(DetailAST aRootAST)
- Description copied from class:
Check
- Called before the starting to process a tree. Ideal place to initialise
information that is to be collected whilst processing a tree.
- Overrides:
beginTree
in class Check
- Parameters:
aRootAST
- the root of the tree- See Also:
com.puppycrawl.tools.checkstyle.api.Check#
finishTree
public void finishTree(DetailAST aRootAST)
- Description copied from class:
Check
- Called after finished processing a tree. Ideal place to report on
information collected whilst processing a tree.
- Overrides:
finishTree
in class Check
- Parameters:
aRootAST
- the root of the tree- See Also:
com.puppycrawl.tools.checkstyle.api.Check#