001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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.ScopeUtils;
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 * @author <a href="mailto:ryly@mail.ru">Ruslan Dyachenko</a>
035 */
036@FileStatefulCheck
037public class InnerTypeLastCheck extends AbstractCheck {
038
039    /**
040     * A key is pointing to the warning message text in "messages.properties"
041     * file.
042     */
043    public static final String MSG_KEY = "arrangement.members.before.inner";
044
045    /** Meet a root class. */
046    private boolean rootClass = true;
047
048    @Override
049    public int[] getDefaultTokens() {
050        return getRequiredTokens();
051    }
052
053    @Override
054    public int[] getAcceptableTokens() {
055        return getRequiredTokens();
056    }
057
058    @Override
059    public int[] getRequiredTokens() {
060        return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF};
061    }
062
063    @Override
064    public void visitToken(DetailAST ast) {
065        // First root class
066        if (rootClass) {
067            rootClass = false;
068        }
069        else {
070            DetailAST nextSibling = ast.getNextSibling();
071            while (nextSibling != null) {
072                if (!ScopeUtils.isInCodeBlock(ast)
073                    && (nextSibling.getType() == TokenTypes.VARIABLE_DEF
074                        || nextSibling.getType() == TokenTypes.METHOD_DEF)) {
075                    log(nextSibling.getLineNo(), nextSibling.getColumnNo(),
076                        MSG_KEY);
077                }
078                nextSibling = nextSibling.getNextSibling();
079            }
080        }
081    }
082
083    @Override
084    public void leaveToken(DetailAST ast) {
085        // Is this a root class
086        if (ast.getParent() == null) {
087            rootClass = true;
088        }
089    }
090}