01: /*
02: * Hammurapi
03: * Automated Java code review system.
04: * Copyright (C) 2004 Hammurapi Group
05: *
06: * This program is free software; you can redistribute it and/or modify
07: * it under the terms of the GNU General Public License as published by
08: * the Free Software Foundation; either version 2 of the License, or
09: * (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: * URL: http://www.hammurapi.org
21: * e-Mail: support@hammurapi.biz
22: */
23: package org.hammurapi.inspectors.formatting;
24:
25: import com.pavelvlasov.jsel.impl.Token;
26: import org.hammurapi.HammurapiException;
27:
28: /**
29: * Common interface for checking the source code formatting of tokens. Different
30: * checkers for different coding styles implement this interface
31: *
32: * @author Jochen Skulj
33: * @author Pavel Vlasov
34: * @version $Revision: 1.1 $
35: */
36: public interface FormattingChecker {
37:
38: /**
39: * checks, if a token violates a rule
40: *
41: * @param aToken
42: * next token to check
43: * @return <code>true<code> if the token violates a rule; otherwise <code>false</code>
44: */
45: boolean check(Token aToken) throws HammurapiException;
46: }
|