com.puppycrawl.tools.checkstyle.checks
Class FileContentsHolder

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.Check
              extended by 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

Constructor Summary
FileContentsHolder()
           
 
Method Summary
 void beginTree(DetailAST aRootAST)
          Called before the starting to process a tree.
 void destroy()
          Destroy the check.
static FileContents getContents()
           
 int[] getDefaultTokens()
          Returns the default token a check is interested in.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
finishTree, 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
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileContentsHolder

public FileContentsHolder()
Method Detail

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:
TokenTypes

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

destroy

public void destroy()
Description copied from class: Check
Destroy the check. It is being retired from service.

Overrides:
destroy in class Check


Copyright © 2001-2012. All Rights Reserved.