* The general rule is that the argument of the {@code @SuppressWarnings} will be - * matched against class name of the checker in lower case and without {@code Check} - * suffix if present. + * matched against class name of the check in any letter case. Adding {@code check} + * suffix is also accepted. *
** If {@code aliasList} property was provided you can use your own names e.g. below @@ -155,7 +155,7 @@ public class SuppressWarningsHolder private static final String JAVA_LANG_PREFIX = "java.lang."; /** Suffix to be removed from subclasses of Check. */ - private static final String CHECK_SUFFIX = "Check"; + private static final String CHECK_SUFFIX = "check"; /** Special warning id for matching all the warnings. */ private static final String ALL_WARNING_MATCHING_ID = "all"; @@ -182,8 +182,8 @@ public class SuppressWarningsHolder /** * Returns the default alias for the source name of a check, which is the - * source name in lower case with any dotted prefix or "Check" suffix - * removed. + * source name in lower case with any dotted prefix or "Check"/"check" + * suffix removed. * * @param sourceName the source name of the check (generally the class * name) @@ -191,11 +191,12 @@ public class SuppressWarningsHolder */ public static String getDefaultAlias(String sourceName) { int endIndex = sourceName.length(); - if (sourceName.endsWith(CHECK_SUFFIX)) { + final String sourceNameLower = sourceName.toLowerCase(Locale.ENGLISH); + if (sourceNameLower.endsWith(CHECK_SUFFIX)) { endIndex -= CHECK_SUFFIX.length(); } - final int startIndex = sourceName.lastIndexOf('.') + 1; - return sourceName.substring(startIndex, endIndex).toLowerCase(Locale.ENGLISH); + final int startIndex = sourceNameLower.lastIndexOf('.') + 1; + return sourceNameLower.substring(startIndex, endIndex); } /** @@ -268,7 +269,8 @@ public static boolean isSuppressed(AuditEvent event) { final String checkName = entry.getCheckName(); final boolean nameMatches = ALL_WARNING_MATCHING_ID.equals(checkName) - || checkName.equalsIgnoreCase(checkAlias); + || checkName.equalsIgnoreCase(checkAlias) + || getDefaultAlias(checkName).equalsIgnoreCase(checkAlias); if (afterStart && beforeEnd && (nameMatches || checkName.equals(event.getModuleId()))) { suppressed = true; diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolderTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolderTest.java index c79741ef90e..637642054df 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolderTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolderTest.java @@ -43,6 +43,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; import com.puppycrawl.tools.checkstyle.api.Violation; import com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck; +import com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck; import com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck; import com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck; import com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck; @@ -505,4 +506,28 @@ public void testSuppressWarningsTextBlocks() throws Exception { getNonCompilablePath("InputSuppressWarningsHolderTextBlocks.java"), expected); } + @Test + public void testWithAndWithoutCheckSuffixDifferentCases() throws Exception { + final Configuration checkConfig = createModuleConfig(SuppressWarningsHolder.class); + final DefaultConfiguration treeWalker = createModuleConfig(TreeWalker.class); + final Configuration filter = createModuleConfig(SuppressWarningsFilter.class); + final DefaultConfiguration violationCheck = createModuleConfig(ConstantNameCheck.class); + + treeWalker.addChild(checkConfig); + treeWalker.addChild(violationCheck); + + final DefaultConfiguration root = createRootConfig(treeWalker); + root.addChild(filter); + + final String pattern = "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"; + final String[] expected = { + "4:30: " + getCheckMessage(ConstantNameCheck.class, + AbstractNameCheck.MSG_INVALID_PATTERN, "a", pattern), + }; + + verify(root, + getPath("InputSuppressWarningsHolderWithAndWithoutCheckSuffixDifferentCases.java"), + expected); + } + } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/suppresswarningsholder/InputSuppressWarningsHolderWithAndWithoutCheckSuffixDifferentCases.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/suppresswarningsholder/InputSuppressWarningsHolderWithAndWithoutCheckSuffixDifferentCases.java new file mode 100644 index 00000000000..b179693078f --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/suppresswarningsholder/InputSuppressWarningsHolderWithAndWithoutCheckSuffixDifferentCases.java @@ -0,0 +1,23 @@ +package com.puppycrawl.tools.checkstyle.checks.suppresswarningsholder; + +public class InputSuppressWarningsHolderWithAndWithoutCheckSuffixDifferentCases { + private static final int a = 0; // violation 'invalid pattern' + + @SuppressWarnings("checkstyle:constantnamecheck") // filtered violation 'invalid pattern' + private static final int b = 0; + + @SuppressWarnings("checkstyle:ConstantName") // filtered violation 'invalid pattern' + private static final int c = 0; + + @SuppressWarnings("checkstyle:ConstantNameCheck") // filtered violation 'invalid pattern' + private static final int d = 0; + + @SuppressWarnings("checkstyle:constantname") // filtered violation 'invalid pattern' + private static final int e = 0; + + @SuppressWarnings("checkstyle:cOnStAnTnAmEcHeCk") // filtered violation 'invalid pattern' + private static final int f = 0; + + @SuppressWarnings("checkstyle:cOnStAnTnAmE") // filtered violation 'invalid pattern' + private static final int g = 0; +} diff --git a/src/xdocs/config_annotation.xml b/src/xdocs/config_annotation.xml index d6ffbba40ce..5f18d6472c0 100644 --- a/src/xdocs/config_annotation.xml +++ b/src/xdocs/config_annotation.xml @@ -1401,8 +1401,8 @@ class Test { }
The general rule is that the argument of the @SuppressWarnings will be
- matched against class name of the checker in lower case and without Check
- suffix if present.
+ matched against class name of the check in any letter case. Adding check
+ suffix is also accepted.
If aliasList property was provided you can use your own names e.g. below
code will work if there was provided a ParameterNumberCheck=paramnum in