Coverage Report - com.puppycrawl.tools.checkstyle.checks.FileContentsHolder
 
Classes in this File Line Coverage Branch Coverage Complexity
FileContentsHolder
100%
8/8
N/A
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2014  Oliver Burn
 4  
 //
 5  
 // This library is free software; you can redistribute it and/or
 6  
 // modify it under the terms of the GNU Lesser General Public
 7  
 // License as published by the Free Software Foundation; either
 8  
 // version 2.1 of the License, or (at your option) any later version.
 9  
 //
 10  
 // This library is distributed in the hope that it will be useful,
 11  
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 12  
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 13  
 // Lesser General Public License for more details.
 14  
 //
 15  
 // You should have received a copy of the GNU Lesser General Public
 16  
 // License along with this library; if not, write to the Free Software
 17  
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 18  
 ////////////////////////////////////////////////////////////////////////////////
 19  
 package com.puppycrawl.tools.checkstyle.checks;
 20  
 
 21  
 import com.puppycrawl.tools.checkstyle.api.Check;
 22  
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 23  
 import com.puppycrawl.tools.checkstyle.api.FileContents;
 24  
 
 25  
 /**
 26  
  * Holds the current file contents for global access when configured
 27  
  * as a TreeWalker sub-module. For example,
 28  
  * a filter can access the current file contents through this module.
 29  
  * @author Mike McMahon
 30  
  * @author Rick Giles
 31  
  */
 32  17
 public class FileContentsHolder
 33  
     extends Check
 34  
 {
 35  
     /** The current file contents. */
 36  1
     private static final ThreadLocal<FileContents> FILE_CONTENTS =
 37  
         new ThreadLocal<FileContents>();
 38  
 
 39  
     /** @return the current file contents. */
 40  
     public static FileContents getContents()
 41  
     {
 42  296
         return FILE_CONTENTS.get();
 43  
     }
 44  
 
 45  
     @Override
 46  
     public int[] getDefaultTokens()
 47  
     {
 48  17
         return new int[0];
 49  
     }
 50  
 
 51  
     @Override
 52  
     public void beginTree(DetailAST aRootAST)
 53  
     {
 54  17
         FILE_CONTENTS.set(getFileContents());
 55  17
     }
 56  
 
 57  
     @Override
 58  
     public void destroy()
 59  
     {
 60  
         // This needs to be called in destroy, rather than finishTree()
 61  
         // as finishTree() is called before the messages are passed to the
 62  
         // filters. Without calling remove, there is a memory leak.
 63  17
         FILE_CONTENTS.remove();
 64  17
     }
 65  
 }