Fail the build on missing Override annotation [LUCENE-6967]

[asfimport]

Spin-off of #8014. Even though javac does not support it, ecj does with this one-liner:

--- lucene/tools/javadoc/ecj.javadocs.prefs	(revision 1723604)
+++ lucene/tools/javadoc/ecj.javadocs.prefs	(working copy)
`@@` -47,7 +47,7 `@@`
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public
-org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=error
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled
 org.eclipse.jdt.core.compiler.problem.missingSerialVersion=ignore
 org.eclipse.jdt.core.compiler.problem.missingSynchronizedOnInheritedMethod=ignore

---

Migrated from LUCENE-6967 by Adrien Grand (@jpountz), updated Jan 12 2016
Attachments: LUCENE-6967.patch (versions: 2)

[asfimport]

Paul Elschot (migrated from JIRA)

This has bitten me too, so I tried the above change.
I could get ant documentation-lint to pass by adding overrides, but the changes include some generated code, see below.

The generated code should be excluded from documentation-lint, or at least the missing override should not throw an error for these files. But how is that done?

This is the git diff --stat=1000 output:

lucene/analysis/common/src/java/org/tartarus/snowball/ext/LithuanianStemmer.java                                 | 6 +++++-
 lucene/analysis/common/src/test/org/apache/lucene/analysis/core/TestRandomChains.java                            | 1 +
 lucene/classification/src/java/org/apache/lucene/classification/CachingNaiveBayesClassifier.java                 | 1 +
 lucene/classification/src/java/org/apache/lucene/classification/document/SimpleNaiveBayesDocumentClassifier.java | 1 +
 lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTOrdTermsReader.java                                    | 2 ++
 lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java                                       | 1 +
 lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextDimensionalWriter.java                      | 3 ++-
 lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundReader.java                               | 1 +
 lucene/core/src/java/org/apache/lucene/codecs/lucene60/Lucene60DimensionalWriter.java                            | 1 +
 lucene/core/src/java/org/apache/lucene/document/FieldType.java                                                   | 1 +
 lucene/core/src/java/org/apache/lucene/index/FreqProxFields.java                                                 | 4 ++++
 lucene/core/src/java/org/apache/lucene/index/MultiDimensionalValues.java                                         | 1 +
 lucene/core/src/java/org/apache/lucene/search/CachingCollector.java                                              | 3 +++
 lucene/core/src/java/org/apache/lucene/search/spans/SpanFirstQuery.java                                          | 1 +
 lucene/core/src/java/org/apache/lucene/search/spans/SpanMultiTermQueryWrapper.java                               | 1 +
 lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionQueue.java                                       | 1 +
 lucene/core/src/java/org/apache/lucene/store/Lock.java                                                           | 1 +
 lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java                                                     | 1 +
 lucene/core/src/java/org/apache/lucene/util/SparseFixedBitSet.java                                               | 2 ++
 lucene/core/src/java/org/apache/lucene/util/packed/BlockPackedWriter.java                                        | 1 +
 lucene/core/src/java/org/apache/lucene/util/packed/MonotonicBlockPackedWriter.java                               | 1 +
 lucene/core/src/test/org/apache/lucene/index/TestDimensionalValues.java                                          | 6 ++++++
 lucene/core/src/test/org/apache/lucene/index/TestLogMergePolicy.java                                             | 1 +
 lucene/core/src/test/org/apache/lucene/index/TestNRTThreads.java                                                 | 1 +
 lucene/core/src/test/org/apache/lucene/index/TestOrdinalMap.java                                                 | 1 +
 lucene/core/src/test/org/apache/lucene/index/TestTerms.java                                                      | 9 +++++++++
 lucene/core/src/test/org/apache/lucene/index/TestTieredMergePolicy.java                                          | 1 +
 lucene/core/src/test/org/apache/lucene/search/TestBooleanQueryVisitSubscorers.java                               | 1 +
 lucene/core/src/test/org/apache/lucene/search/TestLRUQueryCache.java                                             | 1 +
 lucene/core/src/test/org/apache/lucene/search/TestSubScorerFreqs.java                                            | 1 +
 lucene/core/src/test/org/apache/lucene/store/TestFileSwitchDirectory.java                                        | 1 +
 lucene/core/src/test/org/apache/lucene/store/TestMultiMMap.java                                                  | 1 +
 lucene/core/src/test/org/apache/lucene/util/TestFixedBitSet.java                                                 | 1 +
 lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java                               | 1 +
 lucene/highlighter/src/test/org/apache/lucene/search/vectorhighlight/FastVectorHighlighterTest.java              | 1 +
 lucene/misc/src/java/org/apache/lucene/index/Sorter.java                                                         | 1 +
 lucene/misc/src/java/org/apache/lucene/uninverting/DocTermOrds.java                                              | 1 +
 lucene/misc/src/java/org/apache/lucene/uninverting/FieldCacheImpl.java                                           | 8 ++++++++
 lucene/misc/src/test/org/apache/lucene/search/TestEarlyTerminatingSortingCollector.java                          | 1 +
 lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/BytesRefFieldSource.java                  | 1 +
 lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/MultiFloatFunction.java                   | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParser.java                               | 2 ++
 lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/Token.java                                     | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/TokenMgrError.java                             | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/parser/StandardSyntaxParser.java     | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/parser/Token.java                    | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/parser/TokenMgrError.java            | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/parser/Token.java                             | 1 +
 lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/parser/TokenMgrError.java                     | 1 +
 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/LegacyPrefixTree.java                              | 1 +
 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/NumberRangePrefixTree.java                         | 1 +
 lucene/spatial/src/test/org/apache/lucene/spatial/prefix/DateNRStrategyTest.java                                 | 1 +
 lucene/spatial/src/test/org/apache/lucene/spatial/prefix/HeatmapFacetCounterTest.java                            | 1 +
 lucene/spatial/src/test/org/apache/lucene/spatial/prefix/NumberRangeFacetsTest.java                              | 1 +
 lucene/spatial/src/test/org/apache/lucene/spatial/prefix/RandomSpatialOpFuzzyPrefixTree50Test.java               | 1 +
 lucene/spatial/src/test/org/apache/lucene/spatial/spatial4j/Geo3dShapeRectRelationTestCase.java                  | 5 +++++
 lucene/spatial3d/src/java/org/apache/lucene/geo3d/Plane.java                                                     | 1 +
 lucene/spatial3d/src/java/org/apache/lucene/geo3d/XYZBounds.java                                                 | 2 ++
 lucene/suggest/src/java/org/apache/lucene/search/suggest/analyzing/AnalyzingInfixSuggester.java                  | 1 +
 lucene/test-framework/src/java/org/apache/lucene/index/BaseIndexFileFormatTestCase.java                          | 3 +++
 lucene/test-framework/src/test/org/apache/lucene/util/WithNestedTests.java                                       | 2 ++
 lucene/tools/javadoc/ecj.javadocs.prefs                                                                          | 2 +-
 62 files changed, 103 insertions(+), 3 deletions(-)

In case there is interest in this as a patch, please holler.

[asfimport]

Robert Muir (@rmuir) (migrated from JIRA)

ECJ is actually a compiler, so we can't just exclude files because they are generated.

So I think we have to add the missing Overrides in the code generation?

[asfimport]

Michael McCandless (@mikemccand) (migrated from JIRA)

+1 for a patch, thank you Paul Elschot! But I'm also unsure how to handle the gen'd sources. Is it just the javacc generated code that's missing @Override?

[asfimport]

Robert Muir (@rmuir) (migrated from JIRA)

Another possibility would be to make this a warning rather than an error, but pass -Werror to fail on warnings (not sure if ECJ supports that, maybe it does).

Then generated code could just have a SuppressWarnings annotation on the generated class itself.

[asfimport]

Paul Elschot (migrated from JIRA)

Patch of 7 Jan 2015, including added overrides in generated code.

[asfimport]

Paul Elschot (migrated from JIRA)

The generated code is generated by javacc and by antlr.

[asfimport]

Paul Elschot (migrated from JIRA)

Patch of 12 Jan 2016.
Adds missing overrides in non generated code.
Changes the compiler setting for a missing override to a warning.

[asfimport]

Paul Elschot (migrated from JIRA)

With this patch ant clean documentation-lint gives 309 warnings for lucene, and 1228 warnings for lucene and solr together.

This assumes that all of the warnings are caught by my IDE, I had to add some regexes to recognize the warnings by ecj.