001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2015 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.coding;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024import com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck;
025import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
026
027/**
028 * <p>
029 * Checks that classes (except abstract one) define a ctor and don't rely
030 * on the default one.
031 * </p>
032 * <p>
033 * An example of how to configure the check is:
034 * </p>
035 * <pre>
036 * &lt;module name="MissingCtor"/&gt;
037 * </pre>
038 *
039 * @author o_sukhodolsky
040 */
041public class MissingCtorCheck extends DescendantTokenCheck {
042
043    /**
044     * A key is pointing to the warning message text in "messages.properties"
045     * file.
046     */
047    public static final String MSG_KEY = "missing.ctor";
048
049    /** Creates new instance of the check. */
050    public MissingCtorCheck() {
051        setLimitedTokens(TokenUtils.getTokenName(TokenTypes.CTOR_DEF));
052        setMinimumNumber(1);
053        setMaximumDepth(2);
054        setMinimumMessage(MSG_KEY);
055    }
056
057    @Override
058    public int[] getDefaultTokens() {
059        return new int[]{TokenTypes.CLASS_DEF};
060    }
061
062    @Override
063    public int[] getAcceptableTokens() {
064        return getDefaultTokens();
065    }
066
067    @Override
068    public int[] getRequiredTokens() {
069        return getDefaultTokens();
070    }
071
072    @Override
073    public void visitToken(DetailAST ast) {
074        final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
075        if (!modifiers.branchContains(TokenTypes.ABSTRACT)) {
076            super.visitToken(ast);
077        }
078    }
079}