Class FileContentsHolder

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class FileContentsHolder
    extends AbstractCheck
    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.
    • Field Detail

      • currentFileContents

        private static FileContents currentFileContents
        The current file contents.
    • Constructor Detail

      • FileContentsHolder

        public FileContentsHolder()
    • Method Detail

      • getCurrentFileContents

        public static FileContents getCurrentFileContents()
        Returns content of current file.
        Returns:
        the current file contents.
      • getContents

        @Deprecated
        public static FileContents getContents()
        Deprecated.
        use getCurrentFileContents() instead.
        Returns content of current file.
        Returns:
        the current file contents.
      • getDefaultTokens

        public int[] getDefaultTokens()
        Description copied from class: AbstractCheck
        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 AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes
      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Description copied from class: AbstractCheck
        The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
        Specified by:
        getAcceptableTokens in class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes
      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes
      • beginTree

        public void beginTree​(DetailAST rootAST)
        Description copied from class: AbstractCheck
        Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
        Overrides:
        beginTree in class AbstractCheck
        Parameters:
        rootAST - the root of the tree