1919
2020package com .puppycrawl .tools .checkstyle .checks .javadoc ;
2121
22+ import java .util .Arrays ;
2223import java .util .regex .Pattern ;
2324
2425import com .puppycrawl .tools .checkstyle .StatelessCheck ;
2526import com .puppycrawl .tools .checkstyle .api .AbstractCheck ;
2627import com .puppycrawl .tools .checkstyle .api .DetailAST ;
2728import com .puppycrawl .tools .checkstyle .api .FileContents ;
28- import com .puppycrawl .tools .checkstyle .api .Scope ;
2929import com .puppycrawl .tools .checkstyle .api .TextBlock ;
3030import com .puppycrawl .tools .checkstyle .api .TokenTypes ;
31+ import com .puppycrawl .tools .checkstyle .checks .naming .AccessModifierOption ;
32+ import com .puppycrawl .tools .checkstyle .utils .CheckUtil ;
3133import com .puppycrawl .tools .checkstyle .utils .ScopeUtil ;
34+ import com .puppycrawl .tools .checkstyle .utils .UnmodifiableCollectionUtil ;
3235
3336/**
3437 * <div>
3538 * Checks that a variable has a Javadoc comment. Ignores {@code serialVersionUID} fields.
3639 * </div>
3740 * <ul>
3841 * <li>
39- * Property {@code excludeScope} - Specify the visibility scope where Javadoc
40- * comments are not checked.
41- * Type is {@code com.puppycrawl.tools.checkstyle.api.Scope}.
42- * Default value is {@code null}.
42+ * Property {@code accessModifiers} - Specify the set of access modifiers used to determine which
43+ * fields should be checked. This includes both explicitly declared modifiers and implicit ones,
44+ * such as package-private for fields without an explicit modifier.
45+ * It also accounts for special cases where fields have implicit modifiers,
46+ * such as {@code public static final} for interface fields and {@code public static}
47+ * for enum constants. Only fields matching the specified modifiers will be analyzed.
48+ * Type is {@code com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption[]}.
49+ * Default value is {@code public, protected, package, private}.
4350 * </li>
4451 * <li>
4552 * Property {@code ignoreNamePattern} - Specify the regexp to define variable names to ignore.
4653 * Type is {@code java.util.regex.Pattern}.
4754 * Default value is {@code null}.
4855 * </li>
4956 * <li>
50- * Property {@code scope} - Specify the visibility scope where Javadoc comments are checked.
51- * Type is {@code com.puppycrawl.tools.checkstyle.api.Scope}.
52- * Default value is {@code private}.
53- * </li>
54- * <li>
5557 * Property {@code tokens} - tokens to check
5658 * Type is {@code java.lang.String[]}.
5759 * Validation type is {@code tokenSet}.
@@ -84,35 +86,40 @@ public class JavadocVariableCheck
8486 * A key is pointing to the warning message text in "messages.properties"
8587 * file.
8688 */
87- public static final String MSG_JAVADOC_MISSING = "javadoc.missing" ;
88-
89- /** Specify the visibility scope where Javadoc comments are checked. */
90- private Scope scope = Scope .PRIVATE ;
9189
92- /** Specify the visibility scope where Javadoc comments are not checked. */
93- private Scope excludeScope ;
90+ public static final String MSG_JAVADOC_MISSING = "javadoc.missing" ;
91+ /**
92+ * Specify the set of access modifiers used to determine which fields should be checked.
93+ * This includes both explicitly declared modifiers and implicit ones, such as package-private
94+ * for fields without an explicit modifier. It also accounts for special cases where fields
95+ * have implicit modifiers, such as {@code public static final} for interface fields and
96+ * {@code public static} for enum constants.
97+ * Only fields matching the specified modifiers will be analyzed.
98+ */
99+ private AccessModifierOption [] accessModifiers = {
100+ AccessModifierOption .PUBLIC ,
101+ AccessModifierOption .PROTECTED ,
102+ AccessModifierOption .PACKAGE ,
103+ AccessModifierOption .PRIVATE ,
104+ };
94105
95106 /** Specify the regexp to define variable names to ignore. */
96107 private Pattern ignoreNamePattern ;
97108
98109 /**
99- * Setter to specify the visibility scope where Javadoc comments are checked.
110+ * Setter to specify the set of access modifiers used to determine which fields should be
111+ * checked. This includes both explicitly declared modifiers and implicit ones, such as
112+ * package-private for fields without an explicit modifier. It also accounts for special
113+ * cases where fields have implicit modifiers, such as {@code public static final}
114+ * for interface fields and {@code public static} for enum constants.
115+ * Only fields matching the specified modifiers will be analyzed.
100116 *
101- * @param scope a scope .
102- * @since 3 .0
117+ * @param accessModifiers access modifiers of fields to check .
118+ * @since 10.22 .0
103119 */
104- public void setScope (Scope scope ) {
105- this .scope = scope ;
106- }
107-
108- /**
109- * Setter to specify the visibility scope where Javadoc comments are not checked.
110- *
111- * @param excludeScope a scope.
112- * @since 3.4
113- */
114- public void setExcludeScope (Scope excludeScope ) {
115- this .excludeScope = excludeScope ;
120+ public void setAccessModifiers (AccessModifierOption ... accessModifiers ) {
121+ this .accessModifiers =
122+ UnmodifiableCollectionUtil .copyOfArray (accessModifiers , accessModifiers .length );
116123 }
117124
118125 /**
@@ -176,6 +183,17 @@ private boolean isIgnored(DetailAST ast) {
176183 || "serialVersionUID" .equals (name );
177184 }
178185
186+ /**
187+ * Checks whether a method has the correct access modifier to be checked.
188+ *
189+ * @param accessModifier the access modifier of the method.
190+ * @return whether the method matches the expected access modifier.
191+ */
192+ private boolean matchAccessModifiers (AccessModifierOption accessModifier ) {
193+ return Arrays .stream (accessModifiers )
194+ .anyMatch (modifier -> modifier == accessModifier );
195+ }
196+
179197 /**
180198 * Whether we should check this node.
181199 *
@@ -185,14 +203,16 @@ private boolean isIgnored(DetailAST ast) {
185203 private boolean shouldCheck (final DetailAST ast ) {
186204 boolean result = false ;
187205 if (!ScopeUtil .isInCodeBlock (ast ) && !isIgnored (ast )) {
188- final Scope customScope = ScopeUtil .getScope (ast );
189- final Scope surroundingScope = ScopeUtil .getSurroundingScope (ast );
190- result = customScope .isIn (scope ) && surroundingScope .isIn (scope )
191- && (excludeScope == null
192- || !customScope .isIn (excludeScope )
193- || !surroundingScope .isIn (excludeScope ));
206+ try {
207+ final AccessModifierOption accessModifier =
208+ CheckUtil .getAccessModifierFromModifiersToken (ast );
209+ result = matchAccessModifiers (accessModifier );
210+ }
211+ catch (IllegalArgumentException ex ) {
212+ // In case of ENUM_CONSTANT_DEF
213+ result = true ;
214+ }
194215 }
195216 return result ;
196217 }
197-
198218}
0 commit comments