001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2026 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.JavadocCommentsTokenTypes; 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 * {@snippet lang="text" : 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 * } 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" file. 080 */ 081 public static final String MSG_KEY_ANNOTATION_MISSING_DEPRECATED = 082 "annotation.missing.deprecated"; 083 084 /** 085 * A key is pointing to the warning message text in "messages.properties" file. 086 */ 087 public static final String MSG_KEY_JAVADOC_DUPLICATE_TAG = 088 "javadoc.duplicateTag"; 089 090 /** {@link Deprecated Deprecated} annotation name. */ 091 private static final String DEPRECATED = "Deprecated"; 092 093 /** Fully-qualified {@link Deprecated Deprecated} annotation name. */ 094 private static final String FQ_DEPRECATED = "java.lang." + DEPRECATED; 095 096 /** Token types to find parent of. */ 097 private static final BitSet TYPES_HASH_SET = TokenUtil.asBitSet( 098 TokenTypes.TYPE, TokenTypes.MODIFIERS, TokenTypes.ANNOTATION, 099 TokenTypes.ANNOTATIONS, TokenTypes.ARRAY_DECLARATOR, 100 TokenTypes.TYPE_PARAMETERS, TokenTypes.DOT); 101 102 /** 103 * Creates a new {@code MissingDeprecatedCheck} instance. 104 */ 105 public MissingDeprecatedCheck() { 106 // no code by default 107 } 108 109 @Override 110 public int[] getDefaultJavadocTokens() { 111 return getRequiredJavadocTokens(); 112 } 113 114 @Override 115 public int[] getRequiredJavadocTokens() { 116 return new int[] { 117 JavadocCommentsTokenTypes.JAVADOC_CONTENT, 118 }; 119 } 120 121 /** 122 * Setter to control when to print violations if the Javadoc being examined by this check 123 * violates the tight html rules defined at 124 * <a href="https://checkstyle.org/writing-javadoc-checks.html#Tight-HTML_rules"> 125 * Tight-HTML Rules</a>. 126 * 127 * @param shouldReportViolation value to which the field shall be set to 128 * @since 8.3 129 * @propertySince 8.24 130 */ 131 @Override 132 public void setViolateExecutionOnNonTightHtml(boolean shouldReportViolation) { 133 super.setViolateExecutionOnNonTightHtml(shouldReportViolation); 134 } 135 136 @Override 137 public void visitJavadocToken(DetailNode ast) { 138 final DetailAST parentAst = getParent(getBlockCommentAst()); 139 140 final boolean containsAnnotation = 141 AnnotationUtil.containsAnnotation(parentAst, DEPRECATED) 142 || AnnotationUtil.containsAnnotation(parentAst, FQ_DEPRECATED); 143 144 final boolean containsJavadocTag = containsDeprecatedTag(ast); 145 146 if (containsAnnotation ^ containsJavadocTag) { 147 log(parentAst.getLineNo(), MSG_KEY_ANNOTATION_MISSING_DEPRECATED); 148 } 149 } 150 151 /** 152 * Checks to see if the javadoc contains a deprecated tag. 153 * 154 * @param javadoc the javadoc of the AST 155 * @return true if contains the tag 156 */ 157 private boolean containsDeprecatedTag(DetailNode javadoc) { 158 boolean found = false; 159 DetailNode node = javadoc.getFirstChild(); 160 while (node != null) { 161 if (node.getType() == JavadocCommentsTokenTypes.JAVADOC_BLOCK_TAG 162 && node.getFirstChild().getType() 163 == JavadocCommentsTokenTypes.DEPRECATED_BLOCK_TAG) { 164 if (found) { 165 log(node.getLineNumber(), MSG_KEY_JAVADOC_DUPLICATE_TAG, 166 JavadocTagInfo.DEPRECATED.getText()); 167 } 168 found = true; 169 } 170 node = node.getNextSibling(); 171 } 172 return found; 173 } 174 175 /** 176 * Returns the parent node of the comment. 177 * 178 * @param commentBlock child node. 179 * @return parent node. 180 */ 181 private static DetailAST getParent(DetailAST commentBlock) { 182 DetailAST result = commentBlock.getParent(); 183 184 if (TokenUtil.isRootNode(result)) { 185 result = commentBlock.getNextSibling(); 186 } 187 188 while (true) { 189 final int type = result.getType(); 190 if (TYPES_HASH_SET.get(type)) { 191 result = result.getParent(); 192 } 193 else if (type == TokenTypes.SINGLE_LINE_COMMENT) { 194 result = result.getNextSibling(); 195 } 196 else { 197 break; 198 } 199 } 200 201 return result; 202 } 203 204}