Fix #3 Automated metadata testing + metadata corrections (bulk of work by @rnveach)

Author: lkoe

net.sf.eclipsecs.checkstyle/.classpath

@@ -1,8 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
+	<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"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
 	<classpathentry kind="src" path="metadata/"/>
+    <classpathentry kind="src" path="test"/>
 	<classpathentry exported="true" kind="lib" path="checkstyle-8.10-all.jar" sourcepath="checkstyle-checkstyle-8.10.zip"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>

net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.properties

@@ -9,6 +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.
 
 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.

net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.xml

@@ -43,6 +43,9 @@
         <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>
             <message-key key="annotation.missing.deprecated" />
             <message-key key="javadoc.duplicateTag" />
             <message-key key="javadoc.missing" />
@@ -51,7 +54,7 @@
         <rule-metadata name="%MissingOverride.name" internal-name="MissingOverride" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck" />
             <description>%MissingOverride.desc</description>
-            <property-metadata name="javaFiveCompatibility " datatype="Boolean" default-value="false">
+            <property-metadata name="javaFiveCompatibility" datatype="Boolean" default-value="false">
                 <description>%MissingOverride.javaFiveCompatibility</description>
             </property-metadata>
             <message-key key="tag.not.valid.on" />
@@ -102,6 +105,15 @@
                     <property-value-option value="METHOD_DEF" />
                     <property-value-option value="CTOR_DEF" />
                     <property-value-option value="VARIABLE_DEF" />
+                    <property-value-option value="TYPECAST" />
+                    <property-value-option value="DOT" />
+                    <property-value-option value="TYPE_ARGUMENT" />
+                    <property-value-option value="ANNOTATION_DEF" />
+                    <property-value-option value="ANNOTATION_FIELD_DEF" />
+                    <property-value-option value="LITERAL_NEW" />
+                    <property-value-option value="LITERAL_THROWS" />
+                    <property-value-option value="PARAMETER_DEF" />
+                    <property-value-option value="IMPLEMENTS_CLAUSE" />
                 </enumeration>
             </property-metadata>
             <property-metadata name="allowSamelineSingleParameterlessAnnotation" datatype="Boolean"

net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/blocks/checkstyle-metadata.properties

@@ -17,6 +17,7 @@ EmptyCatchBlock.commentFormat = The format of the first comment inside empty cat
 LeftCurly.desc          = Checks for the placement of left curly braces (<code>'{'</code>) for code blocks.<br/>\r\nThe policy to verify is specified using property <code>option</code>.<br/>\r\nPolicies <scode>eol</code> and <code> nlow</code> take into account property <code>maxLineLength</code>.
 LeftCurly.name          = Left Curly Brace Placement
 LeftCurly.option        = policy on placement of a left curly brace ('{')
+LeftCurly.ignoreEnums   = If true, Check will ignore enums when left curly brace policy is EOL
 LeftCurly.tokens        = blocks to check
 
 NeedBraces.desc   = Checks for braces around code blocks.

net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/blocks/checkstyle-metadata.xml

@@ -7,7 +7,6 @@
 
         <rule-metadata name="%AvoidNestedBlocks.name" internal-name="AvoidNestedBlocks" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck"/>
-            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.AvoidNestedBlocksCheck"/>
             <description>%AvoidNestedBlocks.desc</description>
             <property-metadata name="allowInSwitchCase" datatype="Boolean" default-value="false">
                 <description>%AvoidNestedBlocks.allowInSwitchCase</description>
@@ -18,14 +17,13 @@
 
         <rule-metadata name="%EmptyBlock.name" internal-name="EmptyBlock" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck"/>
-            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck"/>
             <description>%EmptyBlock.desc</description>
             <property-metadata name="option" datatype="SingleSelect" default-value="STATEMENT">
                 <description>%EmptyBlock.option</description>
                 <enumeration option-provider="com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption"/>
             </property-metadata>
             <property-metadata name="tokens" datatype="MultiCheck"
-                default-value="LITERAL_WHILE, LITERAL_TRY, LITERAL_FINALLY, LITERAL_DO, LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, INSTANCE_INIT, STATIC_INIT, LITERAL_SWITCH, LITERAL_SYNCHRONIZED">
+                default-value="LITERAL_WHILE,LITERAL_TRY,LITERAL_FINALLY,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR,INSTANCE_INIT,STATIC_INIT,LITERAL_SWITCH,LITERAL_SYNCHRONIZED">
                 <description>%EmptyBlock.tokens</description>
                 <enumeration>
                     <property-value-option value="LITERAL_WHILE"/>
@@ -63,14 +61,16 @@
 
         <rule-metadata name="%LeftCurly.name" internal-name="LeftCurly" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck"/>
-            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck"/>
             <description>%LeftCurly.desc</description>
             <property-metadata name="option" datatype="SingleSelect" default-value="eol">
                 <description>%LeftCurly.option</description>
                 <enumeration option-provider="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption"/>
             </property-metadata>
+            <property-metadata name="ignoreEnums" datatype="Boolean" default-value="true">
+                <description>%LeftCurly.ignoreEnums</description>
+            </property-metadata>
             <property-metadata name="tokens" datatype="MultiCheck"
-                default-value="INTERFACE_DEF,CLASS_DEF,ANNOTATION_DEF,ENUM_DEF,CTOR_DEF,METHOD_DEF,ENUM_CONSTANT_DEF,LITERAL_WHILE,LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_SYNCHRONIZED,LITERAL_SWITCH,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR">
+                default-value="INTERFACE_DEF,CLASS_DEF,ANNOTATION_DEF,ENUM_DEF,CTOR_DEF,METHOD_DEF,ENUM_CONSTANT_DEF,LITERAL_WHILE,LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_SYNCHRONIZED,LITERAL_SWITCH,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR,STATIC_INIT,OBJBLOCK,LAMBDA">
                 <description>%LeftCurly.tokens</description>
                 <enumeration>
                     <property-value-option value="INTERFACE_DEF"/>
@@ -80,6 +80,7 @@
                     <property-value-option value="CTOR_DEF"/>
                     <property-value-option value="METHOD_DEF"/>
                     <property-value-option value="ENUM_CONSTANT_DEF"/>
+                    <property-value-option value="LAMBDA"/>
                     <property-value-option value="LITERAL_WHILE"/>
                     <property-value-option value="LITERAL_TRY"/>
                     <property-value-option value="LITERAL_CATCH"/>
@@ -90,25 +91,30 @@
                     <property-value-option value="LITERAL_IF"/>
                     <property-value-option value="LITERAL_ELSE"/>
                     <property-value-option value="LITERAL_FOR"/>
+                    <property-value-option value="OBJBLOCK"/>
+                    <property-value-option value="STATIC_INIT"/>
                 </enumeration>
             </property-metadata>
             <message-key key="line.new"/>
             <message-key key="line.previous"/>
+            <message-key key="line.break.after"/>
         </rule-metadata>
 
         <rule-metadata name="%NeedBraces.name" internal-name="NeedBraces" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck"/>
-            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck"/>
             <description>%NeedBraces.desc</description>
             <property-metadata name="tokens" datatype="MultiCheck"
-                default-value="LITERAL_DO,LITERAL_ELSE,LITERAL_IF,LITERAL_FOR,LITERAL_WHILE">
+                default-value="LITERAL_DO,LITERAL_ELSE,LITERAL_FOR,LITERAL_IF,LITERAL_WHILE">
                 <description>%NeedBraces.tokens</description>
                 <enumeration>
                     <property-value-option value="LITERAL_DO"/>
                     <property-value-option value="LITERAL_ELSE"/>
                     <property-value-option value="LITERAL_IF"/>
                     <property-value-option value="LITERAL_FOR"/>
                     <property-value-option value="LITERAL_WHILE"/>
+                    <property-value-option value="LITERAL_DEFAULT"/>
+                    <property-value-option value="LITERAL_CASE"/>
+                    <property-value-option value="LAMBDA"/>
                 </enumeration>
             </property-metadata>
             <property-metadata name="allowSingleLineStatement" datatype="Boolean" default-value="false">
@@ -123,7 +129,6 @@
 
         <rule-metadata name="%RightCurly.name" internal-name="RightCurly" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck"/>
-            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck"/>
             <description>%RightCurly.desc</description>
             <property-metadata name="option" datatype="SingleSelect" default-value="same">
                 <description>%RightCurly.option</description>
@@ -155,6 +160,7 @@
             <message-key key="line.alone"/>
             <message-key key="line.same"/>
             <message-key key="line.new"/>
+            <message-key key="line.break.before"/>
         </rule-metadata>
 
 

net.sf.eclipsecs.checkstyle/metadata/com/puppycrawl/tools/checkstyle/checks/checkstyle-metadata.properties

@@ -13,45 +13,19 @@ DescendantToken.minimumMessage = error message when minimum count not reached
 DescendantToken.minimumNumber  = a minimum count for descendants
 DescendantToken.name           = Descendent Token Check
 DescendantToken.sumTokenCounts = whether the number of tokens found should be calculated from the sum of the individual token counts
-DescendantToken.tokens         = Tokens to check.
 
 FinalParameters.desc   = Check that method/constructor parameters are final. Interface methods are not checked - the final keyword does not make sense for interface method parameters as there is no code that could modify the parameter.<br/>\r\nRationale: Changing the value of parameters during the execution of the method's algorithm can be confusing and should be avoided. A great way to let the Java compiler prevent this coding style is to declare parameters final.
 FinalParameters.name   = Final Parameters
 FinalParameters.tokens = Tokens to check.
 FinalParameters.ignorePrimitiveTypes = ignore primitive types as parameters
 
-GenericIllegalRegexp.desc           = A generic check for code problems - the user can search for any pattern. This is similar to a recursive grep, only that it's integrated in checkstyle.<br/>\r\nRationale: This check can be used to prototype checks and to find common bad practice such as calling <code>ex.printStacktrace()</code>, <code>System.out.println()</code>, <code>System.exit()</code>, etc.
-GenericIllegalRegexp.format         = Pattern to check for.
-GenericIllegalRegexp.ignoreCase     = Controls whether to ignore case when searching.
-GenericIllegalRegexp.ignoreComments = Controls whether to ignore text in comments when searching.
-GenericIllegalRegexp.message        = Message which is used to notify about violations, if empty then default(hard-coded) message is used.
-GenericIllegalRegexp.name           = Generic Illegal Regexp
-
-Indentation.basicOffset     = how many spaces to use for new indentation level
-Indentation.braceAdjustment = how far brace should be indented when on next line
-Indentation.caseIndent      = how much to indent a case label
-Indentation.desc            = Checks correct indentation of Java Code.<br/>\r\nThe basic idea behind this is that while pretty printers are sometimes convienent for bulk reformats of legacy code, they often either aren't configurable enough or just can't anticipate how format should be done. Sometimes this is personal preference, other times it is practical experience. In any case, this check should just ensure that a minimal set of indentation rules are followed.
-Indentation.name            = Indentation
-Indentation.throwsIndent    = how far throws should be indented when on next line
-Indentation.arrayInitIndent = how much to indent an array initialization when on next line
-Indentation.lineWrappingIndentation = how far continuation line should be indented when line-wrapping is present
-Indentation.forceStrictCondition = force strict condition in line wrapping case. If value is true, line wrap indent have to be same as lineWrappingIndentation parameter
-
-CommentsIndentation.name    = Comments Indentation
-CommentsIndentation.desc    = Controls the indentation between comments and surrounding code. Comments are indented at the same level as the surrounding code. Detailed info about such convention can be found <a href="http://checkstyle.sourceforge.net/reports/google-java-style.html#s4.8.6.1-block-comment-style">here</a>.
-CommentsIndentation.tokens  = tokens to check
-
 Miscellaneous.group = Miscellaneous
 
 NewlineAtEndOfFile.desc           = Checks whether files end with a new line.<br/>\r\nRationale: Any source files and text files in general should end with a newline character, especially when using SCM systems such as CVS. CVS will even print a warning when it encounters a file that doesn't end with a newline.
 NewlineAtEndOfFile.fileExtensions = file type extension of the files to check.
 NewlineAtEndOfFile.lineSeparator  = type of line separator
 NewlineAtEndOfFile.name           = New Line At End Of File
 
-RequiredRegexp.desc   = A check that makes sure that a specified pattern exists in the code, e.g. a required legal text. It does not care about where in the file the pattern is
-RequiredRegexp.format = required pattern
-RequiredRegexp.name   = Required Regular Expression
-
 TodoComment.desc   = A check for TODO: comments. Actually it is a generic regular expression matcher on Java comments. To check for other patterns in Java comments, set property format.
 TodoComment.format = Regular expression definging pattern to look for.
 TodoComment.name   = Todo Comment
@@ -86,4 +60,8 @@ AvoidEscapedUnicodeCharacters.allowNonPrintableEscapes = Allow non-printable esc
 
 UniqueProperties.name = Unique Properties
 UniqueProperties.desc =  Checks properties file for a duplicated properties.<br/><br/>Rationale: Multiple property keys usually appears after merge or rebase of several branches. While there is no errors in runtime, there can be a confusion on having different values for the duplicated properties.
-UniqueProperties.fileExtensions = file type extension of the files to check.
+UniqueProperties.fileExtensions = file type extension of the files to check.
+
+SuppressWarningsHolder.name = SuppressWarningsHolder
+SuppressWarningsHolder.desc = Maintains a set of check suppressions from {@link SuppressWarnings} annotations.
+SuppressWarningsHolder.aliasList = the list of comma-separated alias assignments