From f153622e3fe38cd3e34854052f0f3a394437ced4 Mon Sep 17 00:00:00 2001 From: Gaurab Dasgupta Date: Thu, 25 Jun 2020 16:27:20 +0530 Subject: [PATCH] Issue #8328: Change name of checkstyle types to be close to real java types - misc --- config/checkstyle_sevntu_checks.xml | 2 +- config/import-control.xml | 2 +- .../tools/checkstyle/api/AutomaticBean.java | 13 +++++---- .../checks/javadoc/JavadocMethodCheck.java | 2 +- .../javadoc/MissingJavadocMethodCheck.java | 2 +- ...odifier.java => AccessModifierOption.java} | 8 +++--- .../checks/naming/ParameterNameCheck.java | 26 +++++++++-------- .../filters/SuppressionXpathSingleFilter.java | 12 ++++---- .../tools/checkstyle/utils/CheckUtil.java | 17 +++++------ .../checkstyle/api/AutomaticBeanTest.java | 17 +++++------ .../checks/naming/ParameterNameCheckTest.java | 2 +- .../checkstyle/internal/XdocsPagesTest.java | 8 +++--- .../tools/checkstyle/utils/CheckUtilTest.java | 18 ++++++------ src/xdocs/config.xml | 2 +- src/xdocs/config_filters.xml | 6 ++-- src/xdocs/config_header.xml | 4 +-- src/xdocs/config_imports.xml | 2 +- src/xdocs/config_javadoc.xml | 28 +++++++++---------- src/xdocs/config_naming.xml | 6 ++-- src/xdocs/property_types.xml | 10 +++---- 20 files changed, 97 insertions(+), 90 deletions(-) rename src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/{AccessModifier.java => AccessModifierOption.java} (88%) diff --git a/config/checkstyle_sevntu_checks.xml b/config/checkstyle_sevntu_checks.xml index 16bb2646212..e8eea5edd4e 100644 --- a/config/checkstyle_sevntu_checks.xml +++ b/config/checkstyle_sevntu_checks.xml @@ -125,7 +125,7 @@ + value="^com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption$"/> diff --git a/config/import-control.xml b/config/import-control.xml index 29e5282a652..8c33a612e36 100644 --- a/config/import-control.xml +++ b/config/import-control.xml @@ -102,7 +102,7 @@ local-only="true"/> - diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/AutomaticBean.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/AutomaticBean.java index 6a7047d3baf..c617815975d 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/AutomaticBean.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/AutomaticBean.java @@ -45,7 +45,7 @@ import org.apache.commons.beanutils.converters.LongConverter; import org.apache.commons.beanutils.converters.ShortConverter; -import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier; +import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption; import com.puppycrawl.tools.checkstyle.utils.CommonUtil; /** @@ -165,7 +165,7 @@ private static void registerCustomTypes(ConvertUtilsBean cub) { cub.register(new SeverityLevelConverter(), SeverityLevel.class); cub.register(new ScopeConverter(), Scope.class); cub.register(new UriConverter(), URI.class); - cub.register(new RelaxedAccessModifierArrayConverter(), AccessModifier[].class); + cub.register(new RelaxedAccessModifierArrayConverter(), AccessModifierOption[].class); } /** @@ -376,14 +376,15 @@ public Object convert(Class type, Object value) { } /** - * A converter that converts strings to {@link AccessModifier}. + * A converter that converts strings to {@link AccessModifierOption}. * This implementation does not care whether the array elements contain characters like '_'. * The normal {@link ArrayConverter} class has problems with this character. */ private static class RelaxedAccessModifierArrayConverter implements Converter { /** Constant for optimization. */ - private static final AccessModifier[] EMPTY_MODIFIER_ARRAY = new AccessModifier[0]; + private static final AccessModifierOption[] EMPTY_MODIFIER_ARRAY = + new AccessModifierOption[0]; @SuppressWarnings("unchecked") @Override @@ -391,11 +392,11 @@ public Object convert(Class type, Object value) { // Converts to a String and trims it for the tokenizer. final StringTokenizer tokenizer = new StringTokenizer( value.toString().trim(), COMMA_SEPARATOR); - final List result = new ArrayList<>(); + final List result = new ArrayList<>(); while (tokenizer.hasMoreTokens()) { final String token = tokenizer.nextToken(); - result.add(AccessModifier.getInstance(token.trim())); + result.add(AccessModifierOption.getInstance(token.trim())); } return result.toArray(EMPTY_MODIFIER_ARRAY); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java index 49e5e111dfa..095b5ad40f1 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java @@ -48,7 +48,7 @@ * Checks the Javadoc of a method or constructor. * The scope to verify is specified using the {@code Scope} class and defaults * to {@code Scope.PRIVATE}. To verify another scope, set property scope to - * a different scope. + * a different scope. *

*

* Violates parameters and type parameters for which no param tags are present can diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java index 871c633a4ed..4bc716214c5 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java @@ -42,7 +42,7 @@ * Checks for missing Javadoc comments for a method or constructor. The scope to verify is * specified using the {@code Scope} class and defaults to {@code Scope.PUBLIC}. To verify * another scope, set property scope to a different - * scope. + * scope. *

*

* Javadoc is not required on a method that is tagged with the {@code @Override} annotation. diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifier.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifierOption.java similarity index 88% rename from src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifier.java rename to src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifierOption.java index e27ad0fadfa..aa270399275 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifier.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AccessModifierOption.java @@ -27,7 +27,7 @@ * https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.6 * */ -public enum AccessModifier { +public enum AccessModifierOption { /** Public access modifier. */ PUBLIC, @@ -52,13 +52,13 @@ private String getName() { * given access modifier name represented as a {@link String}. * The access modifier name can be formatted both as lower case or upper case string. * For example, passing PACKAGE or package as a modifier name - * will return {@link AccessModifier#PACKAGE}. + * will return {@link AccessModifierOption#PACKAGE}. * * @param modifierName access modifier name represented as a {@link String}. * @return the AccessModifier associated with given access modifier name. */ - public static AccessModifier getInstance(String modifierName) { - return valueOf(AccessModifier.class, modifierName.trim().toUpperCase(Locale.ENGLISH)); + public static AccessModifierOption getInstance(String modifierName) { + return valueOf(AccessModifierOption.class, modifierName.trim().toUpperCase(Locale.ENGLISH)); } } diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java index 9a8277b66a6..313caf55bff 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java @@ -59,7 +59,8 @@ * Default value is {@code false}. * *

  • - * Property {@code accessModifiers} - Access modifiers of methods where parameters are checked. + * Property {@code accessModifiers} - Access modifiers of methods where parameters are + * checked. * Default value is {@code public, protected, package, private}. *
    • * @@ -178,11 +179,11 @@ public class ParameterNameCheck extends AbstractNameCheck { private boolean ignoreOverridden; /** Access modifiers of methods where parameters are checked. */ - private AccessModifier[] accessModifiers = { - AccessModifier.PUBLIC, - AccessModifier.PROTECTED, - AccessModifier.PACKAGE, - AccessModifier.PRIVATE, + private AccessModifierOption[] accessModifiers = { + AccessModifierOption.PUBLIC, + AccessModifierOption.PROTECTED, + AccessModifierOption.PACKAGE, + AccessModifierOption.PRIVATE, }; /** @@ -213,7 +214,7 @@ public void setIgnoreOverridden(boolean ignoreOverridden) { * * @param accessModifiers access modifiers of methods which should be checked. */ - public void setAccessModifiers(AccessModifier... accessModifiers) { + public void setAccessModifiers(AccessModifierOption... accessModifiers) { this.accessModifiers = Arrays.copyOf(accessModifiers, accessModifiers.length); } @@ -254,11 +255,11 @@ protected boolean mustCheckName(DetailAST ast) { * @param ast the token of the method/constructor. * @return the access modifier of the method/constructor. */ - private static AccessModifier getAccessModifier(final DetailAST ast) { - final AccessModifier accessModifier; + private static AccessModifierOption getAccessModifier(final DetailAST ast) { + final AccessModifierOption accessModifier; if (ScopeUtil.isInInterfaceOrAnnotationBlock(ast)) { - accessModifier = AccessModifier.PUBLIC; + accessModifier = AccessModifierOption.PUBLIC; } else { final DetailAST params = ast.getParent(); @@ -276,8 +277,9 @@ private static AccessModifier getAccessModifier(final DetailAST ast) { * @param accessModifier the access modifier of the method. * @return whether the method matches the expected access modifier. */ - private boolean matchAccessModifiers(final AccessModifier accessModifier) { - return Arrays.stream(accessModifiers).anyMatch(modifier -> modifier == accessModifier); + private boolean matchAccessModifiers(final AccessModifierOption accessModifier) { + return Arrays.stream(accessModifiers) + .anyMatch(modifier -> modifier == accessModifier); } /** diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java index ef996f6fa04..0a9907187f3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java @@ -49,17 +49,17 @@ *

    *
      *
    • - * Property {@code files} - Define a Regular Expression matched against the file + * Property {@code files} - Define a Regular Expression matched against the file * name associated with an audit event. * Default value is {@code null}. *
      • *
    • - * Property {@code checks} - Define a Regular Expression matched against the name + * Property {@code checks} - Define a Regular Expression matched against the name * of the check associated with an audit event. * Default value is {@code null}. *
      • *
    • - * Property {@code message} - Define a Regular Expression matched against the message + * Property {@code message} - Define a Regular Expression matched against the message * of the check associated with an audit event. * Default value is {@code null}. *
      • @@ -408,16 +408,16 @@ public class SuppressionXpathSingleFilter extends AutomaticBean implements */ private XpathFilterElement xpathFilter; /** - * Define a Regular Expression matched against the file name associated with an audit event. + * Define a Regular Expression matched against the file name associated with an audit event. */ private Pattern files; /** - * Define a Regular Expression matched against the name of the check associated + * Define a Regular Expression matched against the name of the check associated * with an audit event. */ private Pattern checks; /** - * Define a Regular Expression matched against the message of the check + * Define a Regular Expression matched against the message of the check * associated with an audit event. */ private Pattern message; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/utils/CheckUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/utils/CheckUtil.java index fcf8aec716b..8a0f321efb8 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/utils/CheckUtil.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/utils/CheckUtil.java @@ -28,7 +28,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.FullIdent; import com.puppycrawl.tools.checkstyle.api.TokenTypes; -import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier; +import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption; /** * Contains utility methods for the checks. @@ -433,31 +433,32 @@ public static boolean isReceiverParameter(DetailAST parameterDefAst) { } /** - * Returns {@link AccessModifier} based on the information about access modifier + * Returns {@link AccessModifierOption} based on the information about access modifier * taken from the given token of type {@link TokenTypes#MODIFIERS}. * * @param modifiersToken token of type {@link TokenTypes#MODIFIERS}. - * @return {@link AccessModifier}. + * @return {@link AccessModifierOption}. * @throws IllegalArgumentException when expected non-null modifiersToken with type 'MODIFIERS' */ - public static AccessModifier getAccessModifierFromModifiersToken(DetailAST modifiersToken) { + public static AccessModifierOption + getAccessModifierFromModifiersToken(DetailAST modifiersToken) { if (modifiersToken == null || modifiersToken.getType() != TokenTypes.MODIFIERS) { throw new IllegalArgumentException("expected non-null AST-token with type 'MODIFIERS'"); } // default access modifier - AccessModifier accessModifier = AccessModifier.PACKAGE; + AccessModifierOption accessModifier = AccessModifierOption.PACKAGE; for (DetailAST token = modifiersToken.getFirstChild(); token != null; token = token.getNextSibling()) { final int tokenType = token.getType(); if (tokenType == TokenTypes.LITERAL_PUBLIC) { - accessModifier = AccessModifier.PUBLIC; + accessModifier = AccessModifierOption.PUBLIC; } else if (tokenType == TokenTypes.LITERAL_PROTECTED) { - accessModifier = AccessModifier.PROTECTED; + accessModifier = AccessModifierOption.PROTECTED; } else if (tokenType == TokenTypes.LITERAL_PRIVATE) { - accessModifier = AccessModifier.PRIVATE; + accessModifier = AccessModifierOption.PRIVATE; } } return accessModifier; diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/api/AutomaticBeanTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/api/AutomaticBeanTest.java index e4fd9523885..815ce6f65ee 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/api/AutomaticBeanTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/api/AutomaticBeanTest.java @@ -39,7 +39,7 @@ import com.puppycrawl.tools.checkstyle.DefaultConfiguration; import com.puppycrawl.tools.checkstyle.DefaultContext; -import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier; +import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption; public class AutomaticBeanTest { @@ -182,7 +182,7 @@ public void testBeanConverters() throws Exception { bean.setSeverityLevel(null); bean.setScope(null); bean.setUri(null); - bean.setAccessModifiers(AccessModifier.PACKAGE); + bean.setAccessModifiers(AccessModifierOption.PACKAGE); final DefaultConfiguration config = new DefaultConfiguration("bean"); config.addAttribute("strings", "a, b, c"); @@ -198,9 +198,9 @@ public void testBeanConverters() throws Exception { assertEquals(SeverityLevel.ERROR, bean.severityLevel, "invalid result"); assertEquals(Scope.PUBLIC, bean.scope, "invalid result"); assertEquals(new URI("http://github.com"), bean.uri, "invalid result"); - assertArrayEquals( - new AccessModifier[] {AccessModifier.PUBLIC, AccessModifier.PRIVATE}, - bean.accessModifiers, "invalid result"); + assertArrayEquals(new AccessModifierOption[] {AccessModifierOption.PUBLIC, + AccessModifierOption.PRIVATE}, bean.accessModifiers, + "invalid result"); } @Test @@ -288,7 +288,7 @@ public static class ConverterBean extends AutomaticBean { private SeverityLevel severityLevel; private Scope scope; private URI uri; - private AccessModifier[] accessModifiers; + private AccessModifierOption[] accessModifiers; /** * Setter for strings. @@ -340,8 +340,9 @@ public void setUri(URI uri) { * * @param accessModifiers access modifiers. */ - public void setAccessModifiers(AccessModifier... accessModifiers) { - this.accessModifiers = Arrays.copyOf(accessModifiers, accessModifiers.length); + public void setAccessModifiers(AccessModifierOption... accessModifiers) { + this.accessModifiers = Arrays.copyOf(accessModifiers, + accessModifiers.length); } @Override diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheckTest.java index 3cc29f18446..71466a1a4a2 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheckTest.java @@ -142,7 +142,7 @@ public void testPublicAccessModifier() final DefaultConfiguration checkConfig = createModuleConfig(ParameterNameCheck.class); checkConfig.addAttribute("format", "^h$"); - checkConfig.addAttribute("accessModifiers", AccessModifier.PUBLIC.toString()); + checkConfig.addAttribute("accessModifiers", AccessModifierOption.PUBLIC.toString()); final String pattern = "^h$"; diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java index 5406ab669c7..7b823872765 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java @@ -83,7 +83,7 @@ import com.puppycrawl.tools.checkstyle.api.Configuration; import com.puppycrawl.tools.checkstyle.api.Scope; import com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck; -import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier; +import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption; import com.puppycrawl.tools.checkstyle.internal.utils.CheckUtil; import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil; import com.puppycrawl.tools.checkstyle.internal.utils.XdocUtil; @@ -1019,8 +1019,8 @@ else if (fieldClass == Pattern[].class) { else if (fieldClass == Scope.class) { result = "Scope"; } - else if (fieldClass == AccessModifier[].class) { - result = "Access Modifier Set"; + else if (fieldClass == AccessModifierOption[].class) { + result = "AccessModifierOption[]"; } else if ("PropertyCacheFile".equals(fieldClass.getSimpleName())) { result = "File"; @@ -1239,7 +1239,7 @@ else if (fieldClass.isEnum()) { result = value.toString().toLowerCase(Locale.ENGLISH); } } - else if (fieldClass == AccessModifier[].class) { + else if (fieldClass == AccessModifierOption[].class) { result = Arrays.toString((Object[]) value).replace("[", "").replace("]", ""); } else { diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java index ab5044496bc..ada32b1a9ca 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java @@ -40,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.JavaParser; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; -import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier; +import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption; public class CheckUtilTest extends AbstractPathTestSupport { @@ -271,24 +271,24 @@ public void testIsSetterMethod() throws Exception { @Test public void testGetAccessModifierFromModifiersToken() throws Exception { final DetailAST privateVariable = getNodeFromFile(TokenTypes.VARIABLE_DEF); - final AccessModifier modifierPrivate = + final AccessModifierOption modifierPrivate = CheckUtil.getAccessModifierFromModifiersToken(privateVariable.getFirstChild()); - assertEquals(AccessModifier.PRIVATE, modifierPrivate, "Invalid access modifier"); + assertEquals(AccessModifierOption.PRIVATE, modifierPrivate, "Invalid access modifier"); final DetailAST protectedVariable = privateVariable.getNextSibling(); - final AccessModifier modifierProtected = + final AccessModifierOption modifierProtected = CheckUtil.getAccessModifierFromModifiersToken(protectedVariable.getFirstChild()); - assertEquals(AccessModifier.PROTECTED, modifierProtected, "Invalid access modifier"); + assertEquals(AccessModifierOption.PROTECTED, modifierProtected, "Invalid access modifier"); final DetailAST publicVariable = protectedVariable.getNextSibling(); - final AccessModifier modifierPublic = + final AccessModifierOption modifierPublic = CheckUtil.getAccessModifierFromModifiersToken(publicVariable.getFirstChild()); - assertEquals(AccessModifier.PUBLIC, modifierPublic, "Invalid access modifier"); + assertEquals(AccessModifierOption.PUBLIC, modifierPublic, "Invalid access modifier"); final DetailAST packageVariable = publicVariable.getNextSibling(); - final AccessModifier modifierPackage = + final AccessModifierOption modifierPackage = CheckUtil.getAccessModifierFromModifiersToken(packageVariable.getFirstChild()); - assertEquals(AccessModifier.PACKAGE, modifierPackage, "Invalid access modifier"); + assertEquals(AccessModifierOption.PACKAGE, modifierPackage, "Invalid access modifier"); } @Test diff --git a/src/xdocs/config.xml b/src/xdocs/config.xml index 57318c50f16..02430fd0f7b 100644 --- a/src/xdocs/config.xml +++ b/src/xdocs/config.xml @@ -322,7 +322,7 @@ cacheFile caches information about files that have checked OK; used to avoid repeated checks of the same files - File + File null (no cache file) 6.16 diff --git a/src/xdocs/config_filters.xml b/src/xdocs/config_filters.xml index 604da555bd5..0afd90a41c8 100644 --- a/src/xdocs/config_filters.xml +++ b/src/xdocs/config_filters.xml @@ -1409,7 +1409,7 @@ CLASS_DEF -> CLASS_DEF [1:0] files - Define a Regular Expression matched against the file name associated + Define a Regular Expression matched against the file name associated with an audit event. Regular Expression null @@ -1417,7 +1417,7 @@ CLASS_DEF -> CLASS_DEF [1:0] checks - Define a Regular Expression matched against the name of the check + Define a Regular Expression matched against the name of the check associated with an audit event. Regular Expression null @@ -1425,7 +1425,7 @@ CLASS_DEF -> CLASS_DEF [1:0] message - Define a Regular Expression matched against the message of the check associated + Define a Regular Expression matched against the message of the check associated with an audit event. Regular Expression null diff --git a/src/xdocs/config_header.xml b/src/xdocs/config_header.xml index ebd1b831580..488f84014ce 100644 --- a/src/xdocs/config_header.xml +++ b/src/xdocs/config_header.xml @@ -76,7 +76,7 @@ line 5: //////////////////////////////////////////////////////////////////// headerFile Specify the name of the file containing the required header. - URI + URI null 3.2 @@ -291,7 +291,7 @@ line 6: ^\W*$ headerFile Specify the name of the file containing the required header. - URI + URI null 3.2 diff --git a/src/xdocs/config_imports.xml b/src/xdocs/config_imports.xml index 242bd89e8ab..ed85a2a9c55 100644 --- a/src/xdocs/config_imports.xml +++ b/src/xdocs/config_imports.xml @@ -1060,7 +1060,7 @@ public class InputIllegalImport { } It can be a regular file, URL or resource path. It will try loading the path as a URL first, then as a file, and finally as a resource. - URI + URI null 4.0 diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml index f7baf69f4d9..8f5badf5f68 100644 --- a/src/xdocs/config_javadoc.xml +++ b/src/xdocs/config_javadoc.xml @@ -578,7 +578,7 @@ public void method(); to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to a different - scope. + scope.

      @@ -678,14 +678,14 @@ public int checkReturnTag(final int aTagIndex, scope Specify the visibility scope where Javadoc comments are checked. - Scope + Scope private 3.0 excludeScope Specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 3.4 @@ -1385,14 +1385,14 @@ public class TestClass { scope Specify the visibility scope where Javadoc comments are checked. - Scope + Scope private 3.2 excludeScope Specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 3.4 @@ -1876,14 +1876,14 @@ public class Test { scope Specify the visibility scope where Javadoc comments are checked. - Scope + Scope private 3.0 excludeScope Specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 3.4 @@ -2099,14 +2099,14 @@ class DatabaseConfiguration {} scope Specify the visibility scope where Javadoc comments are checked. - Scope + Scope private 3.0 excludeScope Specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 3.4 @@ -2224,7 +2224,7 @@ class DatabaseConfiguration {} The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to a different - scope. + scope.

      @@ -2288,14 +2288,14 @@ public boolean isSomething() scope Specify the visibility scope where Javadoc comments are checked. - Scope + Scope public 8.21 excludeScope Specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 8.21 @@ -2614,14 +2614,14 @@ package com.checkstyle.api; // violation scope specify the visibility scope where Javadoc comments are checked. - Scope + Scope public 8.20 excludeScope specify the visibility scope where Javadoc comments are not checked. - Scope + Scope null 8.20 diff --git a/src/xdocs/config_naming.xml b/src/xdocs/config_naming.xml index 786b4cc602d..722cbade50b 100644 --- a/src/xdocs/config_naming.xml +++ b/src/xdocs/config_naming.xml @@ -2143,7 +2143,8 @@ public boolean equals(Object o) { accessModifiers Access modifiers of methods where parameters are checked. - Access Modifier Set + AccessModifierOption[] + public, protected, package, private 7.5 @@ -2228,7 +2229,8 @@ class MyClass { <module name="ParameterName"> <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/> - <property name="accessModifiers" value="protected, package, private"/> + <property name="accessModifiers" value="protected, package, + private"/> <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''"/> </module> diff --git a/src/xdocs/property_types.xml b/src/xdocs/property_types.xml index 3919d8ba442..1acee1a253b 100644 --- a/src/xdocs/property_types.xml +++ b/src/xdocs/property_types.xml @@ -108,7 +108,7 @@

      -
      +

      This type represents a URI. The string representation is parsed using a custom routine to analyze what type of URI the string is. @@ -118,9 +118,9 @@

      -
      +

      - This type represents a local file. Unlike the uri type, + This type represents a local file. Unlike the uri type, which implies read only and not modifiable access to the resource, a property of this type indicates files whose contents can be modified by Checkstyle.

      @@ -472,7 +472,7 @@
      -
      +

      This type represents a Java scope. Checks use this to determine which methods/fields/classes will be examined by it's logic. The valid options are:

      @@ -495,7 +495,7 @@

      -
      +

      This type represents Java access modifiers.