Issue #166: update to Checkstyle 8.24

Calixte · romani · commit e87be298a6ef · 2019-11-08T21:28:00.000-08:00
diff --git a/net.sf.eclipsecs.checkstyle/.classpath b/net.sf.eclipsecs.checkstyle/.classpath
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry exported="true" kind="lib" path="checkstyle-8.23-all.jar" sourcepath="checkstyle-checkstyle-8.23.zip"/>
+	<classpathentry exported="true" kind="lib" path="checkstyle-8.24-all.jar" sourcepath="checkstyle-checkstyle-8.24.zip"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
diff --git a/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF b/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF
@@ -46,5 +46,5 @@ Export-Package: .,
  com.puppycrawl.tools.checkstyle.utils,
  org.apache.commons.beanutils;version="8.23.0"
 Bundle-ClassPath: .,
- checkstyle-8.23-all.jar
+ checkstyle-8.24-all.jar
 Automatic-Module-Name: net.sf.eclipsecs.checkstyle
diff --git a/net.sf.eclipsecs.checkstyle/build.properties b/net.sf.eclipsecs.checkstyle/build.properties
@@ -1,6 +1,6 @@
 bin.includes = META-INF/,\
                .,\
                license/,\
-               checkstyle-8.23-all.jar
+               checkstyle-8.24-all.jar
 jars.compile.order = .
 source.. = metadata/
diff --git a/net.sf.eclipsecs.checkstyle/checkstyle-8.24-all.jar b/net.sf.eclipsecs.checkstyle/checkstyle-8.24-all.jar
diff --git a/net.sf.eclipsecs.checkstyle/checkstyle-checkstyle-8.24.zip b/net.sf.eclipsecs.checkstyle/checkstyle-checkstyle-8.24.zip
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.properties b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.properties
@@ -9,7 +9,7 @@ AnnotationUseStyle.trailingArrayComma = Defines the policy for trailing comma in
 
 MissingDeprecated.desc = Verifies that both the <code>java.lang.Deprecated</code> annotation is present and the <code>@deprecated</code> Javadoc tag is present when either is present.
 MissingDeprecated.name = Missing Deprecated
-MissingDeprecated.skipNoJavadoc = When this property is set to true check ignore cases when JavaDoc is missing, but still warns when JavaDoc is present but either @deprecated is missing from JavaDoc or @deprecated is missing from the element.
+MissingDeprecated.violateExecutionOnNonTightHtml = If turned on, will print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules
 
 MissingOverride.desc                  = Verifies that the <code>java.lang.Override</code> annotation is present when the <code>{@inheritDoc}</code> javadoc tag is present.
 MissingOverride.javaFiveCompatibility = When this property is true this check will only check classes, interfaces, etc. that do not contain the extends or implements keyword or are not anonymous classes. This means it only checks methods overridden from java.lang.Object.Java 5 Compatibility mode severely limits this check. It is recommended to only use it on Java 5 source.
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.xml b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.xml
@@ -43,12 +43,14 @@
         <rule-metadata name="%MissingDeprecated.name" internal-name="MissingDeprecated" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck" />
             <description>%MissingDeprecated.desc</description>
-            <property-metadata name="skipNoJavadoc" datatype="Boolean" default-value="false">
-                <description>%MissingDeprecated.skipNoJavadoc</description>
+            <property-metadata name="violateExecutionOnNonTightHtml" datatype="Boolean" default-value="false">
+                <description>%MissingDeprecated.violateExecutionOnNonTightHtml</description>
             </property-metadata>
             <message-key key="annotation.missing.deprecated" />
             <message-key key="javadoc.duplicateTag" />
-            <message-key key="javadoc.missing" />
+            <message-key key="javadoc.missed.html.close" />
+            <message-key key="javadoc.parse.rule.error" />
+            <message-key key="javadoc.wrong.singleton.html.tag" />
         </rule-metadata>
 
         <rule-metadata name="%MissingOverride.name" internal-name="MissingOverride" parent="TreeWalker">
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/coding/checkstyle-metadata.properties b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/coding/checkstyle-metadata.properties
@@ -177,6 +177,10 @@ UnnecessaryParentheses.desc = Checks for the use of unnecessary parentheses.
 UnnecessaryParentheses.name = Unnecessary Parentheses
 UnnecessaryParentheses.tokens = tokens to check
 
+UnnecessarySemicolonAfterTypeMemberDeclaration.desc = Checks if unnecessary semicolon is used after type member declaration.
+UnnecessarySemicolonAfterTypeMemberDeclaration.name = Unnecessary semicolon after type member declaration
+UnnecessarySemicolonAfterTypeMemberDeclaration.tokens = tokens to check
+
 UnnecessarySemicolonInEnumeration.desc = Checks if unnecessary semicolon is in enum definitions.
 UnnecessarySemicolonInEnumeration.name = Unnecessary semicolon in enumeration
 
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/coding/checkstyle-metadata.xml b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/coding/checkstyle-metadata.xml
@@ -536,6 +536,29 @@
             <message-key key="unnecessary.paren.lambda" />
         </rule-metadata>
 
+        <rule-metadata name="%UnnecessarySemicolonAfterTypeMemberDeclaration.name" internal-name="UnnecessarySemicolonAfterTypeMemberDeclaration" parent="TreeWalker">
+            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck" />
+            <description>%UnnecessarySemicolonAfterTypeMemberDeclaration.desc</description> 
+            <property-metadata name="tokens" datatype="MultiCheck"
+                default-value="CLASS_DEF,INTERFACE_DEF,ENUM_DEF,ANNOTATION_DEF,VARIABLE_DEF,ANNOTATION_FIELD_DEF,STATIC_INIT,INSTANCE_INIT,CTOR_DEF,METHOD_DEF,ENUM_CONSTANT_DEF">
+                <description>%UnnecessarySemicolonAfterTypeMemberDeclaration.tokens</description>
+                <enumeration>
+                    <property-value-option value="CLASS_DEF"/>
+                    <property-value-option value="INTERFACE_DEF"/>
+                    <property-value-option value="ENUM_DEF"/>
+                    <property-value-option value="ANNOTATION_DEF"/>
+                    <property-value-option value="VARIABLE_DEF"/>
+                    <property-value-option value="ANNOTATION_FIELD_DEF"/>
+                    <property-value-option value="STATIC_INIT"/>
+                    <property-value-option value="INSTANCE_INIT"/>
+                    <property-value-option value="CTOR_DEF"/>
+                    <property-value-option value="METHOD_DEF"/>
+                    <property-value-option value="ENUM_CONSTANT_DEF"/>
+                </enumeration>
+            </property-metadata>
+            <message-key key="unnecessary.semicolon" />
+        </rule-metadata>
+        
         <rule-metadata name="%UnnecessarySemicolonInEnumeration.name" internal-name="UnnecessarySemicolonInEnumeration" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck" />
             <description>%UnnecessarySemicolonInEnumeration.desc</description>
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.properties b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.properties
@@ -105,6 +105,11 @@ AtclauseOrder.violateExecutionOnNonTightHtml = This property determines if a che
 InvalidJavadocPosition.name = Invalid Javadoc Position
 InvalidJavadocPosition.desc = Checks that Javadocs are located at the correct position.
 
+JavadocBlockTagLocation.name                           = Javadoc Block Location
+JavadocBlockTagLocation.desc                           = Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.
+JavadocBlockTagLocation.violateExecutionOnNonTightHtml = Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules
+JavadocBlockTagLocation.tags                           = Specify the javadoc tags to process.
+
 JavadocParagraph.name = Javadoc Paragraph
 JavadocParagraph.desc=Checks that:<ul><li>There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present.</li><li>Each paragraph but the first has &lt;p&gt; immediately before the first word, with no space after.</li></ul>
 JavadocParagraph.allowNewlineParagraph= whether the <p> tag should be placed immediately before the first word
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.xml b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.xml
@@ -398,6 +398,21 @@
             <message-key key="invalid.position" />
         </rule-metadata>
 
+        <rule-metadata name="%JavadocBlockTagLocation.name" internal-name="JavadocBlockTagLocation" parent="TreeWalker">
+            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck" />
+            <description>%JavadocBlockTagLocation.desc</description>
+            <property-metadata name="tags" datatype="String" default-value="author, deprecated, exception, hidden, param, provides, return, see, serial, serialData, serialField, since, throws, uses, version">
+                <description>%JavadocBlockTagLocation.tags</description>
+            </property-metadata>
+            <property-metadata name="violateExecutionOnNonTightHtml" datatype="Boolean" default-value="false">
+                <description>%JavadocBlockTagLocation.violateExecutionOnNonTightHtml</description>
+            </property-metadata>
+            <message-key key="javadoc.blockTagLocation" />
+            <message-key key="javadoc.missed.html.close" />
+            <message-key key="javadoc.parse.rule.error" />
+            <message-key key="javadoc.wrong.singleton.html.tag" />
+        </rule-metadata>
+
         <rule-metadata name="%JavadocParagraph.name" internal-name="JavadocParagraph" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck" />
             <description>%JavadocParagraph.desc</description>
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/sizes/checkstyle-metadata.properties b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/sizes/checkstyle-metadata.properties
@@ -13,10 +13,11 @@ FileLength.max  = Maximum number of lines allowed.
 FileLength.name = Maximum File Length
 FileLength.fileExtensions = file type extension of files to process
 
+LineLength.name          = Maximum Line Length
 LineLength.desc          = Checks for long lines.<br/>\r\nRationale: Long lines are hard to read in printouts or if developers have limited screen space for the source code, e.g. if the IDE displays additional information like project tree, class hierarchy, etc.
+LineLength.fileExtensions = file extensions that are accepted
 LineLength.ignorePattern = Pattern for lines to ignore.
 LineLength.max           = Maximum allowed line length.
-LineLength.name          = Maximum Line Length
 
 MethodLength.countEmpty = whether to count empty lines and single line comments of the form //
 MethodLength.desc       = Checks for long methods and constructors.<br/>\r\nRationale: If a method becomes very long it is hard to understand. Therefore long methods should usually be refactored into several individual methods that focus on a specific task.
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/sizes/checkstyle-metadata.xml b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/sizes/checkstyle-metadata.xml
@@ -45,9 +45,12 @@
             <message-key key="maxLen.file" />
         </rule-metadata>
 
-        <rule-metadata name="%LineLength.name" internal-name="LineLength" parent="TreeWalker">
+        <rule-metadata name="%LineLength.name" internal-name="LineLength" parent="Checker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck" />
             <description>%LineLength.desc</description>
+            <property-metadata name="fileExtensions" datatype="String">
+                <description>%LineLength.fileExtensions</description>
+            </property-metadata>
             <property-metadata name="ignorePattern" datatype="Regex" default-value="^$">
                 <description>%LineLength.ignorePattern</description>
             </property-metadata>
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/filters/checkstyle-metadata.properties b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/filters/checkstyle-metadata.properties
@@ -11,6 +11,7 @@ SuppressWithNearbyCommentFilter.checkCPP        = whether to check C++ style com
 SuppressWithNearbyCommentFilter.checkFormat     = check pattern to suppress.
 SuppressWithNearbyCommentFilter.commentFormat   = comment pattern to trigger filter to begin suppression.
 SuppressWithNearbyCommentFilter.desc            = Filter <code>SuppressWithNearbyCommentFilter</code> uses individual comments to suppress audit events.<br/>\r\n<br/><br/>\r\nRationale: Same as SuppressionCommentFilter. Whereas the SuppressionCommentFilter uses matched pairs of filters to turn on/off comment matching, SuppressWithNearbyCommentFilter uses single comments. This requires fewer lines to mark a region, and may be aesthetically preferable in some contexts.\r\n<br/><br/>\r\nUsage: This filter only works in conjunction with a FileContentsHolder, since that check makes the suppression comments in the .java files available sub rosa. A configuration that includes this filter must configure FileContentsHolder as a child module of TreeWalker. 
+SuppressWithNearbyCommentFilter.idFormat         = Specify check ID pattern to suppress.
 SuppressWithNearbyCommentFilter.influenceFormat = a negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment 
 SuppressWithNearbyCommentFilter.messageFormat   = message pattern to suppress.
 SuppressWithNearbyCommentFilter.name            = Suppress With Nearby Comment Filter
@@ -19,6 +20,7 @@ SuppressionCommentFilter.checkC           = whether to check C style comments (/
 SuppressionCommentFilter.checkCPP         = whether to check C++ style comments (//)
 SuppressionCommentFilter.checkFormat      = check pattern to suppress.
 SuppressionCommentFilter.desc             = Filter <code>SuppressionCommentFilter</code> uses pairs of comments to suppress audit events.<br/>\r\nRationale: Sometimes there are legitimate reasons for violating a check. When this is a matter of the code in question and not personal preference, the best place to override the policy is in the code itself. Semi-structured comments can be associated with the check. This is sometimes superior to a separate suppressions file, which must be kept up-to-date as the source file is edited.
+SuppressionCommentFilter.idFormat         = Specify check ID pattern to suppress.
 SuppressionCommentFilter.messageFormat    = message pattern to suppress.
 SuppressionCommentFilter.name             = Suppression Comment Filter
 SuppressionCommentFilter.offCommentFormat = comment pattern to trigger filter to begin suppression.
@@ -34,6 +36,7 @@ SuppressWarningsFilter.desc = Filter SuppressWarningsFilter uses annotations to
 
 SuppressWithPlainTextCommentFilter.name             = Suppression With Plain Text Comment Filter
 SuppressWithPlainTextCommentFilter.desc             = Filter <code>SuppressWithPlainTextCommentFilter</code> uses plain text to suppress audit events. The filter can be used only to suppress audit events received from the checks which implement FileSetCheck interface. In other words, the checks which have Checker as a parent module. The filter knows nothing about AST, it treats only plain text comments and extracts the information required for suppression from the plain text comments. Currently the filter supports only single line comments.<br/><br/>Please, be aware of the fact that, it is not recommended to use the filter for Java code anymore, however you still are able to use it to suppress audit events received from the checks which implement FileSetCheck interface.<br/><br/><b>Rationale:</b> Sometimes there are legitimate reasons for violating a check. When this is a matter of the code in question and not personal preference, the best place to override the policy is in the code itself. Semi-structured comments can be associated with the check. This is sometimes superior to a separate suppressions file, which must be kept up-to-date as the source file is edited.<br/><br/>Note that the suppression comment should be put before the violation. You can use more than one suppression comment each on separate line. 
+SuppressWithPlainTextCommentFilter.idFormat         = Specify check ID pattern to suppress.
 SuppressWithPlainTextCommentFilter.offCommentFormat = comment pattern to trigger filter to begin suppression.
 SuppressWithPlainTextCommentFilter.onCommentFormat  = comment pattern to trigger filter to end suppression.
 SuppressWithPlainTextCommentFilter.checkFormat      = check pattern to suppress.
diff --git a/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/filters/checkstyle-metadata.xml b/net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/filters/checkstyle-metadata.xml
@@ -51,6 +51,9 @@
             <property-metadata name="messageFormat" datatype="Regex">
                 <description>%SuppressionCommentFilter.messageFormat</description>
             </property-metadata>
+            <property-metadata name="idFormat" datatype="Regex">
+                <description>%SuppressionCommentFilter.idFormat</description>
+            </property-metadata>
             <property-metadata name="checkCPP" datatype="Boolean" default-value="true">
                 <description>%SuppressionCommentFilter.checkCPP</description>
             </property-metadata>
@@ -72,6 +75,9 @@
             <property-metadata name="messageFormat" datatype="Regex">
                 <description>%SuppressWithNearbyCommentFilter.messageFormat</description>
             </property-metadata>
+            <property-metadata name="idFormat" datatype="Regex">
+                <description>%SuppressWithNearbyCommentFilter.idFormat</description>
+            </property-metadata>
             <property-metadata name="influenceFormat" datatype="Regex" default-value="0">
                 <description>%SuppressWithNearbyCommentFilter.influenceFormat</description>
             </property-metadata>
@@ -99,6 +105,9 @@
             <property-metadata name="messageFormat" datatype="Regex">
                 <description>%SuppressWithPlainTextCommentFilter.messageFormat</description>
             </property-metadata>
+            <property-metadata name="idFormat" datatype="Regex">
+                <description>%SuppressWithPlainTextCommentFilter.idFormat</description>
+            </property-metadata>
         </rule-metadata>
 
         <rule-metadata name="%SuppressWarningsFilter.name" internal-name="SuppressWarningsFilter" parent="Checker"
