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.coding;
021
022import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
023import com.puppycrawl.tools.checkstyle.api.DetailAST;
024import com.puppycrawl.tools.checkstyle.api.TokenTypes;
025
026/**
027 * <p>
028 * Checks that classes (except abstract one) define a ctor and don't rely
029 * on the default one.
030 * </p>
031 * <p>
032 * An example of how to configure the check is:
033 * </p>
034 * <pre>
035 * &lt;module name="MissingCtor"/&gt;
036 * </pre>
037 *
038 * @author o_sukhodolsky
039 */
040public class MissingCtorCheck extends AbstractCheck {
041
042    /**
043     * A key is pointing to the warning message text in "messages.properties"
044     * file.
045     */
046    public static final String MSG_KEY = "missing.ctor";
047
048    @Override
049    public int[] getDefaultTokens() {
050        return new int[] {TokenTypes.CLASS_DEF};
051    }
052
053    @Override
054    public int[] getAcceptableTokens() {
055        return getDefaultTokens();
056    }
057
058    @Override
059    public int[] getRequiredTokens() {
060        return getDefaultTokens();
061    }
062
063    @Override
064    public void visitToken(DetailAST ast) {
065        final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
066        if (!modifiers.branchContains(TokenTypes.ABSTRACT)
067                && ast.findFirstToken(TokenTypes.OBJBLOCK)
068                    .findFirstToken(TokenTypes.CTOR_DEF) == null) {
069            log(ast.getLineNo(), MSG_KEY);
070        }
071    }
072}