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.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
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 */
041@StatelessCheck
042public class MissingCtorCheck extends AbstractCheck {
043
044    /**
045     * A key is pointing to the warning message text in "messages.properties"
046     * file.
047     */
048    public static final String MSG_KEY = "missing.ctor";
049
050    @Override
051    public int[] getDefaultTokens() {
052        return getRequiredTokens();
053    }
054
055    @Override
056    public int[] getAcceptableTokens() {
057        return getRequiredTokens();
058    }
059
060    @Override
061    public int[] getRequiredTokens() {
062        return new int[] {TokenTypes.CLASS_DEF};
063    }
064
065    @Override
066    public void visitToken(DetailAST ast) {
067        final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
068        if (modifiers.findFirstToken(TokenTypes.ABSTRACT) == null
069                && ast.findFirstToken(TokenTypes.OBJBLOCK)
070                    .findFirstToken(TokenTypes.CTOR_DEF) == null) {
071            log(ast.getLineNo(), MSG_KEY);
072        }
073    }
074}