Issue #5900: renamed format property to illegalAbstractClassNameFormat

checkstyle · Feb 22, 2019 · 96483bd · 96483bd
1 parent 817febb
commit 96483bd
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java
@@ -41,7 +41,7 @@
  *
  * <p>Check has following properties:
  *
- * <p><b>format</b> - Pattern for illegal class names.
+ * <p><b>illegalAbstractClassNameFormat</b> - Pattern for illegal abstract class names.
  *
  * <p><b>legalAbstractClassNames</b> - Abstract classes that may be used as types.
  *
@@ -130,7 +130,7 @@ public final class IllegalTypeCheck extends AbstractCheck {
     private List<Integer> memberModifiers;
 
     /** The regexp to match against. */
-    private Pattern format = Pattern.compile("^(.*[.])?Abstract.*$");
+    private Pattern illegalAbstractClassNameFormat = Pattern.compile("^(.*[.])?Abstract.*$");
 
     /**
      * Controls whether to validate abstract class names.
@@ -147,8 +147,8 @@ public IllegalTypeCheck() {
      * Set the format for the specified regular expression.
      * @param pattern a pattern.
      */
-    public void setFormat(Pattern pattern) {
-        format = pattern;
+    public void setIllegalAbstractClassNameFormat(Pattern pattern) {
+        illegalAbstractClassNameFormat = pattern;
     }
 
     /**
@@ -460,7 +460,7 @@ private boolean isMatchingClassName(String className) {
                 || illegalShortClassNames.contains(shortName)
                 || validateAbstractClassNames
                     && !legalAbstractClassNames.contains(className)
-                    && format.matcher(className).find();
+                    && illegalAbstractClassNameFormat.matcher(className).find();
     }
 
     /**

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheckTest.java
@@ -93,7 +93,7 @@ public void testIgnoreMethodNames() throws Exception {
     @Test
     public void testFormat() throws Exception {
         final DefaultConfiguration checkConfig = createModuleConfig(IllegalTypeCheck.class);
-        checkConfig.addAttribute("format", "^$");
+        checkConfig.addAttribute("illegalAbstractClassNameFormat", "^$");
 
         final String[] expected = {
             "16:13: " + getCheckMessage(MSG_KEY, "java.util.TreeSet"),

diff --git a/src/xdocs/config_coding.xml b/src/xdocs/config_coding.xml
@@ -2109,8 +2109,8 @@ class SomeClass
             <td>3.2</td>
           </tr>
           <tr>
-            <td>format</td>
-            <td>Pattern for illegal class names.</td>
+            <td>illegalAbstractClassNameFormat</td>
+            <td>Pattern for illegal abstract class names.</td>
             <td><a href="property_types.html#regexp">Regular Expression</a></td>
             <td><code>"^(.*[.])?Abstract.*$"</code></td>
             <td>3.2</td>