001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2025 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.annotation; 021 022import java.util.BitSet; 023 024import com.puppycrawl.tools.checkstyle.StatelessCheck; 025import com.puppycrawl.tools.checkstyle.api.DetailAST; 026import com.puppycrawl.tools.checkstyle.api.DetailNode; 027import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; 028import com.puppycrawl.tools.checkstyle.api.TokenTypes; 029import com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck; 030import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo; 031import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil; 032import com.puppycrawl.tools.checkstyle.utils.TokenUtil; 033 034/** 035 * <div> 036 * Verifies that the annotation {@code @Deprecated} and the Javadoc tag 037 * {@code @deprecated} are both present when either of them is present. 038 * </div> 039 * 040 * <p> 041 * Both ways of flagging deprecation serve their own purpose. 042 * The @Deprecated annotation is used for compilers and development tools. 043 * The @deprecated javadoc tag is used to document why something is deprecated 044 * and what, if any, alternatives exist. 045 * </p> 046 * 047 * <p> 048 * In order to properly mark something as deprecated both forms of 049 * deprecation should be present. 050 * </p> 051 * 052 * <p> 053 * Package deprecation is an exception to the rule of always using the 054 * javadoc tag and annotation to deprecate. It is not clear if the javadoc 055 * tool will support it or not as newer versions keep flip-flopping on if 056 * it is supported or will cause an error. See 057 * <a href="https://bugs.openjdk.org/browse/JDK-8160601">JDK-8160601</a>. 058 * The deprecated javadoc tag is currently the only way to say why the package 059 * is deprecated and what to use instead. Until this is resolved, if you don't 060 * want to print violations on package-info, you can use a 061 * <a href="https://checkstyle.org/filters/index.html">filter</a> to ignore 062 * these files until the javadoc tool faithfully supports it. An example config 063 * using SuppressionSingleFilter is: 064 * </p> 065 * <div class="wrapper"><pre class="prettyprint"><code class="language-xml"> 066 * <!-- required till https://bugs.openjdk.org/browse/JDK-8160601 --> 067 * <module name="SuppressionSingleFilter"> 068 * <property name="checks" value="MissingDeprecatedCheck"/> 069 * <property name="files" value="package-info\.java"/> 070 * </module> 071 * </code></pre></div> 072 * 073 * @since 5.0 074 */ 075@StatelessCheck 076public final class MissingDeprecatedCheck extends AbstractJavadocCheck { 077 078 /** 079 * A key is pointing to the warning message text in "messages.properties" 080 * file. 081 */ 082 public static final String MSG_KEY_ANNOTATION_MISSING_DEPRECATED = 083 "annotation.missing.deprecated"; 084 085 /** 086 * A key is pointing to the warning message text in "messages.properties" 087 * file. 088 */ 089 public static final String MSG_KEY_JAVADOC_DUPLICATE_TAG = 090 "javadoc.duplicateTag"; 091 092 /** {@link Deprecated Deprecated} annotation name. */ 093 private static final String DEPRECATED = "Deprecated"; 094 095 /** Fully-qualified {@link Deprecated Deprecated} annotation name. */ 096 private static final String FQ_DEPRECATED = "java.lang." + DEPRECATED; 097 098 /** Token types to find parent of. */ 099 private static final BitSet TYPES_HASH_SET = TokenUtil.asBitSet( 100 TokenTypes.TYPE, TokenTypes.MODIFIERS, TokenTypes.ANNOTATION, 101 TokenTypes.ANNOTATIONS, TokenTypes.ARRAY_DECLARATOR, 102 TokenTypes.TYPE_PARAMETERS, TokenTypes.DOT); 103 104 @Override 105 public int[] getDefaultJavadocTokens() { 106 return getRequiredJavadocTokens(); 107 } 108 109 @Override 110 public int[] getRequiredJavadocTokens() { 111 return new int[] { 112 JavadocTokenTypes.JAVADOC, 113 }; 114 } 115 116 /** 117 * Setter to control when to print violations if the Javadoc being examined by this check 118 * violates the tight html rules defined at 119 * <a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules"> 120 * Tight-HTML Rules</a>. 121 * 122 * @param shouldReportViolation value to which the field shall be set to 123 * @since 8.3 124 * @propertySince 8.24 125 * @noinspection RedundantMethodOverride 126 * @noinspectionreason Display module's unique property version 127 */ 128 @Override 129 public void setViolateExecutionOnNonTightHtml(boolean shouldReportViolation) { 130 super.setViolateExecutionOnNonTightHtml(shouldReportViolation); 131 } 132 133 @Override 134 public void visitJavadocToken(DetailNode ast) { 135 final DetailAST parentAst = getParent(getBlockCommentAst()); 136 137 final boolean containsAnnotation = 138 AnnotationUtil.containsAnnotation(parentAst, DEPRECATED) 139 || AnnotationUtil.containsAnnotation(parentAst, FQ_DEPRECATED); 140 141 final boolean containsJavadocTag = containsDeprecatedTag(ast); 142 143 if (containsAnnotation ^ containsJavadocTag) { 144 log(parentAst.getLineNo(), MSG_KEY_ANNOTATION_MISSING_DEPRECATED); 145 } 146 } 147 148 /** 149 * Checks to see if the javadoc contains a deprecated tag. 150 * 151 * @param javadoc the javadoc of the AST 152 * @return true if contains the tag 153 */ 154 private boolean containsDeprecatedTag(DetailNode javadoc) { 155 boolean found = false; 156 for (DetailNode child : javadoc.getChildren()) { 157 if (child.getType() == JavadocTokenTypes.JAVADOC_TAG 158 && child.getChildren()[0].getType() == JavadocTokenTypes.DEPRECATED_LITERAL) { 159 if (found) { 160 log(child.getLineNumber(), MSG_KEY_JAVADOC_DUPLICATE_TAG, 161 JavadocTagInfo.DEPRECATED.getText()); 162 } 163 found = true; 164 } 165 } 166 return found; 167 } 168 169 /** 170 * Returns the parent node of the comment. 171 * 172 * @param commentBlock child node. 173 * @return parent node. 174 */ 175 private static DetailAST getParent(DetailAST commentBlock) { 176 DetailAST result = commentBlock.getParent(); 177 178 if (TokenUtil.isRootNode(result)) { 179 result = commentBlock.getNextSibling(); 180 } 181 182 while (true) { 183 final int type = result.getType(); 184 if (TYPES_HASH_SET.get(type)) { 185 result = result.getParent(); 186 } 187 else if (type == TokenTypes.SINGLE_LINE_COMMENT) { 188 result = result.getNextSibling(); 189 } 190 else { 191 break; 192 } 193 } 194 195 return result; 196 } 197 198}