KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > FileContentsHolder


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 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 public class FileContentsHolder
33     extends Check
34 {
35     /** The current file contents. */
36     private static final ThreadLocal JavaDoc FILE_CONTENTS = new ThreadLocal JavaDoc();
37
38     /** @return the current file contents. */
39     public static FileContents getContents()
40     {
41         return (FileContents) FILE_CONTENTS.get();
42     }
43
44     /** {@inheritDoc} */
45     public int[] getDefaultTokens()
46     {
47         return new int[0];
48     }
49
50     /** {@inheritDoc} */
51     public void beginTree(DetailAST aRootAST)
52     {
53         FILE_CONTENTS.set(getFileContents());
54     }
55
56     /** {@inheritDoc} */
57     public void finishTree(DetailAST aRootAST)
58     {
59         // This seems like the right thing to do, but is called before
60 // the messages are passed to the filters.
61 //sFileContents.set(null);
62 }
63 }
64
Popular Tags