View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.coding;
21  
22  import com.puppycrawl.tools.checkstyle.StatelessCheck;
23  import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24  import com.puppycrawl.tools.checkstyle.api.DetailAST;
25  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
26  
27  /**
28   * <p>
29   * Checks that classes (except abstract one) define a ctor and don't rely
30   * on the default one.
31   * </p>
32   * <p>
33   * An example of how to configure the check is:
34   * </p>
35   * <pre>
36   * &lt;module name="MissingCtor"/&gt;
37   * </pre>
38   *
39   * @author o_sukhodolsky
40   */
41  @StatelessCheck
42  public class MissingCtorCheck extends AbstractCheck {
43  
44      /**
45       * A key is pointing to the warning message text in "messages.properties"
46       * file.
47       */
48      public static final String MSG_KEY = "missing.ctor";
49  
50      @Override
51      public int[] getDefaultTokens() {
52          return getRequiredTokens();
53      }
54  
55      @Override
56      public int[] getAcceptableTokens() {
57          return getRequiredTokens();
58      }
59  
60      @Override
61      public int[] getRequiredTokens() {
62          return new int[] {TokenTypes.CLASS_DEF};
63      }
64  
65      @Override
66      public void visitToken(DetailAST ast) {
67          final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
68          if (modifiers.findFirstToken(TokenTypes.ABSTRACT) == null
69                  && ast.findFirstToken(TokenTypes.OBJBLOCK)
70                      .findFirstToken(TokenTypes.CTOR_DEF) == null) {
71              log(ast.getLineNo(), MSG_KEY);
72          }
73      }
74  }