001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2019 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.design;
021
022import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.ScopeUtil;
027
028/**
029 * <p>
030 * Check nested (internal) classes/interfaces are declared at the bottom of the
031 * class after all method and field declarations.
032 * </p>
033 *
034 */
035@FileStatefulCheck
036public class InnerTypeLastCheck extends AbstractCheck {
037
038    /**
039     * A key is pointing to the warning message text in "messages.properties"
040     * file.
041     */
042    public static final String MSG_KEY = "arrangement.members.before.inner";
043
044    /** Meet a root class. */
045    private boolean rootClass = true;
046
047    @Override
048    public int[] getDefaultTokens() {
049        return getRequiredTokens();
050    }
051
052    @Override
053    public int[] getAcceptableTokens() {
054        return getRequiredTokens();
055    }
056
057    @Override
058    public int[] getRequiredTokens() {
059        return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF};
060    }
061
062    @Override
063    public void beginTree(DetailAST rootAST) {
064        rootClass = true;
065    }
066
067    @Override
068    public void visitToken(DetailAST ast) {
069        // First root class
070        if (rootClass) {
071            rootClass = false;
072        }
073        else {
074            DetailAST nextSibling = ast.getNextSibling();
075            while (nextSibling != null) {
076                if (!ScopeUtil.isInCodeBlock(ast)
077                    && (nextSibling.getType() == TokenTypes.VARIABLE_DEF
078                        || nextSibling.getType() == TokenTypes.METHOD_DEF)) {
079                    log(nextSibling, MSG_KEY);
080                }
081                nextSibling = nextSibling.getNextSibling();
082            }
083        }
084    }
085
086    @Override
087    public void leaveToken(DetailAST ast) {
088        // Is this a root class
089        if (ast.getParent() == null) {
090            rootClass = true;
091        }
092    }
093
094}