001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2020 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 * Checks nested (internal) classes/interfaces are declared at the bottom of the
031 * primary (top-level) class after all method and field declarations.
032 * </p>
033 * <p>
034 * To configure the check:
035 * </p>
036 * <pre>
037 * &lt;module name=&quot;InnerTypeLast&quot;/&gt;
038 * </pre>
039 *
040 * @since 5.2
041 */
042@FileStatefulCheck
043public class InnerTypeLastCheck extends AbstractCheck {
044
045    /**
046     * A key is pointing to the warning message text in "messages.properties"
047     * file.
048     */
049    public static final String MSG_KEY = "arrangement.members.before.inner";
050
051    /** Meet a root class. */
052    private boolean rootClass = true;
053
054    @Override
055    public int[] getDefaultTokens() {
056        return getRequiredTokens();
057    }
058
059    @Override
060    public int[] getAcceptableTokens() {
061        return getRequiredTokens();
062    }
063
064    @Override
065    public int[] getRequiredTokens() {
066        return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF};
067    }
068
069    @Override
070    public void beginTree(DetailAST rootAST) {
071        rootClass = true;
072    }
073
074    @Override
075    public void visitToken(DetailAST ast) {
076        // First root class
077        if (rootClass) {
078            rootClass = false;
079        }
080        else {
081            DetailAST nextSibling = ast.getNextSibling();
082            while (nextSibling != null) {
083                if (!ScopeUtil.isInCodeBlock(ast)
084                    && (nextSibling.getType() == TokenTypes.VARIABLE_DEF
085                        || nextSibling.getType() == TokenTypes.METHOD_DEF)) {
086                    log(nextSibling, MSG_KEY);
087                }
088                nextSibling = nextSibling.getNextSibling();
089            }
090        }
091    }
092
093    @Override
094    public void leaveToken(DetailAST ast) {
095        // Is this a root class
096        if (ast.getParent() == null) {
097            rootClass = true;
098        }
099    }
100
101}