| //////////////////////////////////////////////////////////////////////////////// |
| // checkstyle: Checks Java source code for adherence to a set of rules. |
| // Copyright (C) 2001-2017 the original author or authors. |
| // |
| // This library is free software; you can redistribute it and/or |
| // modify it under the terms of the GNU Lesser General Public |
| // License as published by the Free Software Foundation; either |
| // version 2.1 of the License, or (at your option) any later version. |
| // |
| // This library is distributed in the hope that it will be useful, |
| // but WITHOUT ANY WARRANTY; without even the implied warranty of |
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| // Lesser General Public License for more details. |
| // |
| // You should have received a copy of the GNU Lesser General Public |
| // License along with this library; if not, write to the Free Software |
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package com.puppycrawl.tools.checkstyle.checks.sizes; |
| |
| import com.puppycrawl.tools.checkstyle.FileStatefulCheck; |
| import com.puppycrawl.tools.checkstyle.api.AbstractCheck; |
| import com.puppycrawl.tools.checkstyle.api.DetailAST; |
| import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
| |
| /** |
| * Checks for the number of defined types at the "outer" level. |
| * @author oliverb |
| */ |
| @FileStatefulCheck |
| public class OuterTypeNumberCheck extends AbstractCheck { |
| |
| /** |
| * A key is pointing to the warning message text in "messages.properties" |
| * file. |
| */ |
| public static final String MSG_KEY = "maxOuterTypes"; |
| |
| /** The maximum allowed number of outer types. */ |
| private int max = 1; |
| /** Tracks the current depth in types. */ |
| private int currentDepth; |
| /** Tracks the number of outer types found. */ |
| private int outerNum; |
| |
| @Override |
| public int[] getDefaultTokens() { |
| return getRequiredTokens(); |
| } |
| |
| @Override |
| public int[] getAcceptableTokens() { |
| return getRequiredTokens(); |
| } |
| |
| @Override |
| public int[] getRequiredTokens() { |
| return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, |
| TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, }; |
| } |
| |
| @Override |
| public void beginTree(DetailAST ast) { |
| currentDepth = 0; |
| outerNum = 0; |
| } |
| |
| @Override |
| public void finishTree(DetailAST ast) { |
| if (max < outerNum) { |
| log(ast, MSG_KEY, outerNum, max); |
| } |
| } |
| |
| @Override |
| public void visitToken(DetailAST ast) { |
| if (currentDepth == 0) { |
| outerNum++; |
| } |
| currentDepth++; |
| } |
| |
| @Override |
| public void leaveToken(DetailAST ast) { |
| currentDepth--; |
| } |
| |
| /** |
| * Sets the maximum allowed number of outer types. |
| * @param max the new number. |
| */ |
| public void setMax(int max) { |
| this.max = max; |
| } |
| } |