Coverage Report - com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
 
Classes in this File Line Coverage Branch Coverage Complexity
MissingOverrideCheck
100%
36/36
100%
26/26
3.167
 
 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.annotation;
 21  
 
 22  
 import java.util.regex.Matcher;
 23  
 import java.util.regex.Pattern;
 24  
 
 25  
 import com.puppycrawl.tools.checkstyle.StatelessCheck;
 26  
 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
 27  
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 28  
 import com.puppycrawl.tools.checkstyle.api.TextBlock;
 29  
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 30  
 import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo;
 31  
 import com.puppycrawl.tools.checkstyle.utils.AnnotationUtility;
 32  
 import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
 33  
 
 34  
 /**
 35  
  * <p>
 36  
  * This class is used to verify that the {@link Override Override}
 37  
  * annotation is present when the inheritDoc javadoc tag is present.
 38  
  * </p>
 39  
  *
 40  
  * <p>
 41  
  * Rationale: The {@link Override Override} annotation helps
 42  
  * compiler tools ensure that an override is actually occurring.  It is
 43  
  * quite easy to accidentally overload a method or hide a static method
 44  
  * and using the {@link Override Override} annotation points
 45  
  * out these problems.
 46  
  * </p>
 47  
  *
 48  
  * <p>
 49  
  * This check will log a violation if using the inheritDoc tag on a method that
 50  
  * is not valid (ex: private, or static method).
 51  
  * </p>
 52  
  *
 53  
  * <p>
 54  
  * There is a slight difference between the Override annotation in Java 5 versus
 55  
  * Java 6 and above. In Java 5, any method overridden from an interface cannot
 56  
  * be annotated with Override. In Java 6 this behavior is allowed.
 57  
  * </p>
 58  
  *
 59  
  * <p>
 60  
  * As a result of the aforementioned difference between Java 5 and Java 6, a
 61  
  * property called {@code javaFiveCompatibility } is available. This
 62  
  * property will only check classes, interfaces, etc. that do not contain the
 63  
  * extends or implements keyword or are not anonymous classes. This means it
 64  
  * only checks methods overridden from {@code java.lang.Object}
 65  
  *
 66  
  * <b>Java 5 Compatibility mode severely limits this check. It is recommended to
 67  
  * only use it on Java 5 source</b>
 68  
  * </p>
 69  
  *
 70  
  * <pre>
 71  
  * &lt;module name=&quot;MissingOverride&quot;&gt;
 72  
  *    &lt;property name=&quot;javaFiveCompatibility&quot;
 73  
  *        value=&quot;true&quot;/&gt;
 74  
  * &lt;/module&gt;
 75  
  * </pre>
 76  
  *
 77  
  * @author Travis Schneeberger
 78  
  */
 79  
 @StatelessCheck
 80  22
 public final class MissingOverrideCheck extends AbstractCheck {
 81  
     /**
 82  
      * A key is pointing to the warning message text in "messages.properties"
 83  
      * file.
 84  
      */
 85  
     public static final String MSG_KEY_TAG_NOT_VALID_ON = "tag.not.valid.on";
 86  
 
 87  
     /**
 88  
      * A key is pointing to the warning message text in "messages.properties"
 89  
      * file.
 90  
      */
 91  
     public static final String MSG_KEY_ANNOTATION_MISSING_OVERRIDE =
 92  
         "annotation.missing.override";
 93  
 
 94  
     /** {@link Override Override} annotation name. */
 95  
     private static final String OVERRIDE = "Override";
 96  
 
 97  
     /** Fully-qualified {@link Override Override} annotation name. */
 98  
     private static final String FQ_OVERRIDE = "java.lang." + OVERRIDE;
 99  
 
 100  
     /** Compiled regexp to match Javadoc tags with no argument and {}. */
 101  2
     private static final Pattern MATCH_INHERIT_DOC =
 102  1
             CommonUtils.createPattern("\\{\\s*@(inheritDoc)\\s*\\}");
 103  
 
 104  
     /**
 105  
      * Java 5 compatibility option.
 106  
      * @see #setJavaFiveCompatibility(boolean)
 107  
      */
 108  
     private boolean javaFiveCompatibility;
 109  
 
 110  
     /**
 111  
      * Sets Java 5 compatibility mode.
 112  
      *
 113  
      * <p>
 114  
      * In Java 5, this check could flag code that is not valid for the Override
 115  
      * annotation even though it is a proper override. See the class
 116  
      * documentation for more information.
 117  
      * </p>
 118  
      *
 119  
      * <p>
 120  
      * Set this to true to turn on Java 5 compatibility mode. Set this to
 121  
      * false to turn off Java 5 compatibility mode.
 122  
      * </p>
 123  
      *
 124  
      * @param compatibility compatibility or not
 125  
      */
 126  
     public void setJavaFiveCompatibility(final boolean compatibility) {
 127  9
         javaFiveCompatibility = compatibility;
 128  9
     }
 129  
 
 130  
     @Override
 131  
     public int[] getDefaultTokens() {
 132  36
         return getRequiredTokens();
 133  
     }
 134  
 
 135  
     @Override
 136  
     public int[] getAcceptableTokens() {
 137  5
         return getRequiredTokens();
 138  
     }
 139  
 
 140  
     @Override
 141  
     public int[] getRequiredTokens() {
 142  77
         return new int[]
 143  
         {TokenTypes.METHOD_DEF, };
 144  
     }
 145  
 
 146  
     // -@cs[CyclomaticComplexity] Too complex to break apart.
 147  
     @Override
 148  
     public void visitToken(final DetailAST ast) {
 149  91
         final TextBlock javadoc =
 150  91
             getFileContents().getJavadocBefore(ast.getLineNo());
 151  
 
 152  91
         final boolean containsTag = containsJavadocTag(javadoc);
 153  91
         if (containsTag && !JavadocTagInfo.INHERIT_DOC.isValidOn(ast)) {
 154  4
             log(ast.getLineNo(), MSG_KEY_TAG_NOT_VALID_ON,
 155  2
                 JavadocTagInfo.INHERIT_DOC.getText());
 156  
         }
 157  
         else {
 158  89
             boolean check = true;
 159  
 
 160  89
             if (javaFiveCompatibility) {
 161  44
                 final DetailAST defOrNew = ast.getParent().getParent();
 162  
 
 163  44
                 if (defOrNew.findFirstToken(TokenTypes.EXTENDS_CLAUSE) != null
 164  32
                     || defOrNew.findFirstToken(TokenTypes.IMPLEMENTS_CLAUSE) != null
 165  26
                     || defOrNew.getType() == TokenTypes.LITERAL_NEW) {
 166  28
                     check = false;
 167  
                 }
 168  
             }
 169  
 
 170  89
             if (check
 171  
                 && containsTag
 172  38
                 && !AnnotationUtility.containsAnnotation(ast, OVERRIDE)
 173  24
                 && !AnnotationUtility.containsAnnotation(ast, FQ_OVERRIDE)) {
 174  19
                 log(ast.getLineNo(), MSG_KEY_ANNOTATION_MISSING_OVERRIDE);
 175  
             }
 176  
         }
 177  91
     }
 178  
 
 179  
     /**
 180  
      * Checks to see if the text block contains a inheritDoc tag.
 181  
      *
 182  
      * @param javadoc the javadoc of the AST
 183  
      * @return true if contains the tag
 184  
      */
 185  
     private static boolean containsJavadocTag(final TextBlock javadoc) {
 186  91
         boolean javadocTag = false;
 187  
 
 188  91
         if (javadoc != null) {
 189  64
             final String[] lines = javadoc.getText();
 190  
 
 191  152
             for (final String line : lines) {
 192  148
                 final Matcher matchInheritDoc =
 193  148
                     MATCH_INHERIT_DOC.matcher(line);
 194  
 
 195  148
                 if (matchInheritDoc.find()) {
 196  60
                     javadocTag = true;
 197  60
                     break;
 198  
                 }
 199  
             }
 200  
         }
 201  91
         return javadocTag;
 202  
     }
 203  
 }