Source code: com/puppycrawl/tools/checkstyle/checks/AbstractImportCheck.java
1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2002 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.FullIdent;
24
25 /**
26 * Abstract class that provides helper functionality for determining an import
27 * name. It caches the import name in the token context to improve
28 * performance.
29 *
30 * @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
31 * @version 1.0
32 */
33 public abstract class AbstractImportCheck
34 extends Check
35 {
36 /**
37 * Return the name of the import associated with a specifed DetailAST.
38 *
39 * @param aAST the node containing the import
40 * @return a <code>String</code> value
41 */
42 protected FullIdent getImportText(DetailAST aAST)
43 {
44 return FullIdent.createFullIdent((DetailAST) aAST.getFirstChild());
45 }
46 }