You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by dw...@apache.org on 2022/09/24 13:40:34 UTC
[lucene] branch main updated: Upgrade google java format and apply tidy (#11811)
This is an automated email from the ASF dual-hosted git repository.
dweiss pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git
The following commit(s) were added to refs/heads/main by this push:
new 54fba99cb13 Upgrade google java format and apply tidy (#11811)
54fba99cb13 is described below
commit 54fba99cb131c7414caf2c21b52aa990ac17db3e
Author: Dawid Weiss <da...@carrotsearch.com>
AuthorDate: Sat Sep 24 15:40:27 2022 +0200
Upgrade google java format and apply tidy (#11811)
---
gradle/validation/spotless.gradle | 2 +-
lucene/CHANGES.txt | 1 +
.../lucene/analysis/classic/ClassicAnalyzer.java | 4 +-
.../lucene/analysis/classic/ClassicTokenizer.java | 4 +-
.../analysis/compound/hyphenation/Hyphenation.java | 8 +-
.../compound/hyphenation/PatternParser.java | 4 +-
.../lucene/analysis/de/GermanStemFilter.java | 4 +-
.../analysis/email/UAX29URLEmailAnalyzer.java | 4 +-
.../analysis/email/UAX29URLEmailTokenizer.java | 4 +-
.../lucene/analysis/hunspell/AffixedWord.java | 16 +++-
.../apache/lucene/analysis/hunspell/DictEntry.java | 4 +-
.../lucene/analysis/hunspell/Dictionary.java | 8 +-
.../lucene/analysis/hunspell/EntrySuggestion.java | 4 +-
.../apache/lucene/analysis/hunspell/Hunspell.java | 4 +-
.../analysis/hunspell/ModifyingSuggester.java | 4 +-
.../org/apache/lucene/analysis/morph/Token.java | 16 +++-
.../apache/lucene/analysis/pt/RSLPStemmerBase.java | 12 ++-
.../lucene/analysis/shingle/ShingleFilter.java | 4 +-
.../analysis/synonym/TestMultiWordSynonyms.java | 4 +-
.../analysis/icu/segmentation/ScriptIterator.java | 4 +-
.../java/org/apache/lucene/analysis/ja/Token.java | 24 ++++--
.../lucene/analysis/ja/dict/TokenInfoFST.java | 4 +-
.../lucene/analysis/ko/dict/TokenInfoFST.java | 4 +-
.../lucene/analysis/cn/smart/hhmm/PathNode.java | 8 +-
.../lucene/analysis/cn/smart/hhmm/SegToken.java | 8 +-
.../analysis/cn/smart/hhmm/SegTokenPair.java | 8 +-
.../Lucene50CompressingStoredFieldsReader.java | 4 +-
.../Lucene50CompressingTermVectorsReader.java | 4 +-
.../apache/lucene/benchmark/byTask/Benchmark.java | 8 +-
.../lucene/benchmark/byTask/PerfRunData.java | 52 +++++++++---
.../lucene/benchmark/byTask/stats/TaskStats.java | 36 ++++++---
.../lucene/benchmark/byTask/tasks/PerfTask.java | 28 +++++--
.../benchmark/byTask/tasks/TaskSequence.java | 24 ++++--
.../lucene/benchmark/byTask/utils/Config.java | 16 +++-
.../lucene/benchmark/quality/QualityBenchmark.java | 8 +-
.../lucene/codecs/uniformsplit/BlockHeader.java | 24 ++++--
.../uniformsplit/DeltaBaseTermStateSerializer.java | 4 +-
.../lucene/codecs/uniformsplit/FieldMetadata.java | 12 ++-
.../codecs/uniformsplit/IntersectBlockReader.java | 4 +-
.../lucene/codecs/uniformsplit/TermBytes.java | 4 +-
.../uniformsplit/UniformSplitPostingsFormat.java | 4 +-
.../uniformsplit/UniformSplitTermsReader.java | 4 +-
.../uniformsplit/UniformSplitTermsWriter.java | 4 +-
.../java/org/apache/lucene/analysis/Tokenizer.java | 4 +-
.../Lucene90CompressingStoredFieldsReader.java | 4 +-
.../Lucene90CompressingTermVectorsReader.java | 4 +-
.../codecs/lucene94/ExpandingVectorValues.java | 4 +-
.../lucene/index/DocumentsWriterFlushQueue.java | 4 +-
.../apache/lucene/index/LiveIndexWriterConfig.java | 4 +-
.../apache/lucene/search/DisjunctionMaxQuery.java | 12 ++-
.../java/org/apache/lucene/search/FuzzyQuery.java | 4 +-
.../org/apache/lucene/search/MultiTermQuery.java | 4 +-
.../org/apache/lucene/search/SegmentCacheable.java | 4 +-
.../apache/lucene/store/ByteBuffersDataOutput.java | 8 +-
.../java/org/apache/lucene/store/FSDirectory.java | 4 +-
.../src/java/org/apache/lucene/util/CharsRef.java | 12 ++-
.../src/java/org/apache/lucene/util/MapOfSets.java | 8 +-
.../lucene/util/RecyclingByteBlockAllocator.java | 12 ++-
.../lucene/util/RecyclingIntBlockAllocator.java | 12 ++-
.../src/java/org/apache/lucene/util/Version.java | 4 +-
.../src/java/org/apache/lucene/util/fst/FST.java | 12 ++-
.../org/apache/lucene/util/hnsw/NeighborQueue.java | 4 +-
.../org/apache/lucene/util/hppc/IntIntHashMap.java | 4 +-
.../org/apache/lucene/util/packed/PackedInts.java | 4 +-
.../lucene/util/packed/PackedLongValues.java | 12 ++-
.../org/apache/lucene/index/TestOmitPositions.java | 4 +-
.../src/generated/checksums/generateAntlr.json | 4 +-
.../lucene/expressions/js/JavascriptLexer.java | 4 +-
.../lucene/expressions/js/JavascriptParser.java | 4 +-
.../lucene/facet/taxonomy/directory/Consts.java | 4 +-
.../search/grouping/AllGroupHeadsCollector.java | 4 +-
.../grouping/FirstPassGroupingCollector.java | 8 +-
.../search/grouping/GroupFacetCollector.java | 8 +-
.../lucene/search/grouping/GroupSelector.java | 4 +-
.../grouping/SecondPassGroupingCollector.java | 4 +-
.../apache/lucene/search/highlight/Encoder.java | 4 +-
.../lucene/search/highlight/Highlighter.java | 4 +-
.../lucene/search/highlight/QueryScorer.java | 16 +++-
.../lucene/search/highlight/SimpleFragmenter.java | 12 ++-
.../search/highlight/SimpleSpanFragmenter.java | 4 +-
.../lucene/search/highlight/TextFragment.java | 12 ++-
.../apache/lucene/search/highlight/TokenGroup.java | 8 +-
.../lucene/search/highlight/WeightedTerm.java | 16 +++-
.../lucene/search/matchhighlight/OffsetRange.java | 4 +-
.../uhighlight/LabelledCharArrayMatcher.java | 4 +-
.../apache/lucene/search/uhighlight/Passage.java | 16 +++-
.../search/uhighlight/UnifiedHighlighter.java | 20 +++--
.../search/vectorhighlight/FieldPhraseList.java | 16 +++-
.../lucene/search/vectorhighlight/FieldQuery.java | 8 +-
.../search/vectorhighlight/FieldTermStack.java | 12 ++-
.../apache/lucene/luke/app/desktop/LukeMain.java | 4 +-
.../lucene/luke/util/CircularLogBufferHandler.java | 4 +-
.../lucene/misc/store/DirectIODirectory.java | 4 +-
.../apache/lucene/monitor/CandidateMatcher.java | 4 +-
.../org/apache/lucene/monitor/ExplainingMatch.java | 4 +-
.../org/apache/lucene/monitor/HighlightsMatch.java | 12 ++-
.../org/apache/lucene/monitor/MatchingQueries.java | 24 ++++--
.../java/org/apache/lucene/monitor/Monitor.java | 8 +-
.../lucene/monitor/MonitorConfiguration.java | 16 +++-
.../org/apache/lucene/monitor/MonitorQuery.java | 16 +++-
.../lucene/monitor/MultiMatchingQueries.java | 20 +++--
.../java/org/apache/lucene/monitor/QueryMatch.java | 4 +-
.../lucene/monitor/TermFilteredPresearcher.java | 4 +-
.../lucene/queries/function/FunctionQuery.java | 8 +-
.../queries/function/FunctionScoreQuery.java | 8 +-
.../lucene/queries/function/FunctionValues.java | 8 +-
.../queries/intervals/FilteredIntervalsSource.java | 4 +-
.../lucene/queries/intervals/IntervalFilter.java | 4 +-
.../apache/lucene/queries/mlt/MoreLikeThis.java | 4 +-
.../lucene/queries/mlt/MoreLikeThisQuery.java | 4 +-
.../queries/spans/SpanPositionCheckQuery.java | 4 +-
.../queries/spans/SpanPositionRangeQuery.java | 8 +-
.../lucene/queries/function/TestValueSources.java | 8 +-
.../queryparser/classic/QueryParserBase.java | 16 +++-
.../queryparser/flexible/core/QueryNodeError.java | 8 +-
.../flexible/core/QueryNodeParseException.java | 12 ++-
.../flexible/core/nodes/AndQueryNode.java | 4 +-
.../flexible/core/nodes/AnyQueryNode.java | 8 +-
.../flexible/core/nodes/BooleanQueryNode.java | 4 +-
.../flexible/core/nodes/FieldQueryNode.java | 8 +-
.../flexible/core/nodes/FuzzyQueryNode.java | 4 +-
.../flexible/core/nodes/OpaqueQueryNode.java | 8 +-
.../flexible/core/nodes/OrQueryNode.java | 4 +-
.../flexible/core/nodes/PathQueryNode.java | 16 +++-
.../flexible/core/nodes/PhraseSlopQueryNode.java | 4 +-
.../flexible/core/nodes/ProximityQueryNode.java | 12 ++-
.../processors/QueryNodeProcessorPipeline.java | 92 ++++++++++++++++------
.../lucene/queryparser/flexible/messages/NLS.java | 4 +-
.../flexible/messages/NLSException.java | 4 +-
.../flexible/precedence/PrecedenceQueryParser.java | 8 +-
.../standard/CommonQueryParserConfiguration.java | 12 ++-
.../flexible/standard/StandardQueryParser.java | 12 ++-
.../replicator/IndexAndTaxonomyRevision.java | 4 +-
.../lucene/replicator/SessionExpiredException.java | 12 ++-
.../org/apache/lucene/replicator/SessionToken.java | 8 +-
.../lucene/payloads/PayloadSpanCollector.java | 4 +-
.../lucene/sandbox/search/DocValuesTermsQuery.java | 8 +-
.../lucene/sandbox/search/ProfilerCollector.java | 12 ++-
.../sandbox/search/ProfilerCollectorResult.java | 16 +++-
.../sandbox/search/QueryProfilerIndexSearcher.java | 8 +-
.../lucene/spatial/vector/PointVectorStrategy.java | 4 +-
.../spatial3d/tests/RandomGeo3dShapeGenerator.java | 4 +-
.../lucene/spatial3d/geom/GeoComplexPolygon.java | 8 +-
.../lucene/search/suggest/fst/FSTCompletion.java | 8 +-
.../org/apache/lucene/tests/mockfile/ExtrasFS.java | 4 +-
.../lucene/tests/search/MatchesTestBase.java | 4 +-
.../apache/lucene/tests/util/LuceneTestCase.java | 8 +-
.../util/TestRuleSetupAndRestoreClassEnv.java | 4 +-
.../tests/util/TestRuleSetupTeardownChained.java | 8 +-
.../tests/util/TestRuleTemporaryFilesCleanup.java | 8 +-
.../lucene/tests/util/TestMaxFailuresRule.java | 4 +-
.../lucene/tests/util/TestSysoutsLimits.java | 4 +-
152 files changed, 991 insertions(+), 332 deletions(-)
diff --git a/gradle/validation/spotless.gradle b/gradle/validation/spotless.gradle
index 4c0257be10d..685bf0cec5b 100644
--- a/gradle/validation/spotless.gradle
+++ b/gradle/validation/spotless.gradle
@@ -37,7 +37,7 @@ configure(project(":lucene").subprojects) { prj ->
lineEndings 'UNIX'
endWithNewline()
- googleJavaFormat('1.13.0')
+ googleJavaFormat('1.15.0')
// Apply to all Java sources
target "src/**/*.java"
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index db9b0bc6965..269eb39d6eb 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -120,6 +120,7 @@ Other
---------------------
* LUCENE-10423: Remove usages of System.currentTimeMillis() from tests. (Marios Trivyzas)
+* GITHUB#11811: upgrade google java format to 1.15.0 (Dawid Weiss)
======================== Lucene 9.4.0 =======================
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicAnalyzer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicAnalyzer.java
index e76803ccdeb..61f5a66b053 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicAnalyzer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicAnalyzer.java
@@ -81,7 +81,9 @@ public final class ClassicAnalyzer extends StopwordAnalyzerBase {
maxTokenLength = length;
}
- /** @see #setMaxTokenLength */
+ /**
+ * @see #setMaxTokenLength
+ */
public int getMaxTokenLength() {
return maxTokenLength;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicTokenizer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicTokenizer.java
index 50f5e438279..660fa8d5b04 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicTokenizer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/ClassicTokenizer.java
@@ -88,7 +88,9 @@ public final class ClassicTokenizer extends Tokenizer {
this.maxTokenLength = length;
}
- /** @see #setMaxTokenLength */
+ /**
+ * @see #setMaxTokenLength
+ */
public int getMaxTokenLength() {
return maxTokenLength;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/Hyphenation.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/Hyphenation.java
index 6b28ea52f3e..948f695e877 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/Hyphenation.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/Hyphenation.java
@@ -31,12 +31,16 @@ public class Hyphenation {
hyphenPoints = points;
}
- /** @return the number of hyphenation points in the word */
+ /**
+ * @return the number of hyphenation points in the word
+ */
public int length() {
return hyphenPoints.length;
}
- /** @return the hyphenation points */
+ /**
+ * @return the hyphenation points
+ */
public int[] getHyphenationPoints() {
return hyphenPoints;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/PatternParser.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/PatternParser.java
index e399c0c9fb6..3f746491da5 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/PatternParser.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/PatternParser.java
@@ -314,7 +314,9 @@ public class PatternParser extends DefaultHandler {
}
}
- /** @see org.xml.sax.ContentHandler#characters(char[], int, int) */
+ /**
+ * @see org.xml.sax.ContentHandler#characters(char[], int, int)
+ */
@SuppressWarnings({"unchecked", "rawtypes"})
@Override
public void characters(char[] ch, int start, int length) {
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanStemFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanStemFilter.java
index 9d52c735ba3..9a94781561e 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanStemFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanStemFilter.java
@@ -51,7 +51,9 @@ public final class GermanStemFilter extends TokenFilter {
super(in);
}
- /** @return Returns true for next token in the stream, or false at EOS */
+ /**
+ * @return Returns true for next token in the stream, or false at EOS
+ */
@Override
public boolean incrementToken() throws IOException {
if (input.incrementToken()) {
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailAnalyzer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailAnalyzer.java
index 60205954ada..6bde418a54f 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailAnalyzer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailAnalyzer.java
@@ -79,7 +79,9 @@ public final class UAX29URLEmailAnalyzer extends StopwordAnalyzerBase {
maxTokenLength = length;
}
- /** @see #setMaxTokenLength */
+ /**
+ * @see #setMaxTokenLength
+ */
public int getMaxTokenLength() {
return maxTokenLength;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailTokenizer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailTokenizer.java
index cd83182e0d9..a33c4ea7e46 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailTokenizer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/UAX29URLEmailTokenizer.java
@@ -100,7 +100,9 @@ public final class UAX29URLEmailTokenizer extends Tokenizer {
}
}
- /** @see #setMaxTokenLength */
+ /**
+ * @see #setMaxTokenLength
+ */
public int getMaxTokenLength() {
return maxTokenLength;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/AffixedWord.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/AffixedWord.java
index f0b8b1b58a4..d5533281efc 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/AffixedWord.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/AffixedWord.java
@@ -36,22 +36,30 @@ public final class AffixedWord {
this.suffixes = Collections.unmodifiableList(suffixes);
}
- /** @return the word being analyzed */
+ /**
+ * @return the word being analyzed
+ */
public String getWord() {
return word;
}
- /** @return the dictionary entry for the stem in this analysis */
+ /**
+ * @return the dictionary entry for the stem in this analysis
+ */
public DictEntry getDictEntry() {
return entry;
}
- /** @return the list of prefixes applied to the stem, at most two, outermost first */
+ /**
+ * @return the list of prefixes applied to the stem, at most two, outermost first
+ */
public List<Affix> getPrefixes() {
return prefixes;
}
- /** @return the list of suffixes applied to the stem, at most two, outermost first */
+ /**
+ * @return the list of suffixes applied to the stem, at most two, outermost first
+ */
public List<Affix> getSuffixes() {
return suffixes;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/DictEntry.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/DictEntry.java
index ee76e77c39a..c01040a6902 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/DictEntry.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/DictEntry.java
@@ -57,7 +57,9 @@ public abstract class DictEntry {
return Objects.hash(stem, getFlags(), getMorphologicalData());
}
- /** @return the stem word in the dictionary */
+ /**
+ * @return the stem word in the dictionary
+ */
public String getStem() {
return stem;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Dictionary.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Dictionary.java
index 89fb3ccd586..09212794a8b 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Dictionary.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Dictionary.java
@@ -1006,7 +1006,9 @@ public class Dictionary {
return wordCount;
}
- /** @return the number of word entries written */
+ /**
+ * @return the number of word entries written
+ */
private int writeNormalizedWordEntry(StringBuilder reuse, ByteSequencesWriter writer, String line)
throws IOException {
int flagSep = line.indexOf(FLAG_SEPARATOR);
@@ -1369,7 +1371,9 @@ public class Dictionary {
*/
abstract String printFlag(char flag);
- /** @return a presentable sorted concatenation of {@link #printFlag} results */
+ /**
+ * @return a presentable sorted concatenation of {@link #printFlag} results
+ */
String printFlags(char[] encodedFlags) {
List<String> printed = new ArrayList<>();
for (char c : encodedFlags) {
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/EntrySuggestion.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/EntrySuggestion.java
index 3fe489dcb22..b188150b713 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/EntrySuggestion.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/EntrySuggestion.java
@@ -41,7 +41,9 @@ public class EntrySuggestion {
return toEdit;
}
- /** @return new dictionary entries to be added to accommodate the given word list */
+ /**
+ * @return new dictionary entries to be added to accommodate the given word list
+ */
public List<DictEntry> getEntriesToAdd() {
return toAdd;
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Hunspell.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Hunspell.java
index 1fd85fc27aa..32e53ae17ce 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Hunspell.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/Hunspell.java
@@ -75,7 +75,9 @@ public class Hunspell {
stemmer = new Stemmer(dictionary);
}
- /** @return whether the given word's spelling is considered correct according to Hunspell rules */
+ /**
+ * @return whether the given word's spelling is considered correct according to Hunspell rules
+ */
public boolean spell(String word) {
checkCanceled.run();
if (word.isEmpty()) return true;
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/ModifyingSuggester.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/ModifyingSuggester.java
index ab26bf9c3b4..5a4f25a6e9a 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/ModifyingSuggester.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/ModifyingSuggester.java
@@ -40,7 +40,9 @@ class ModifyingSuggester {
this.wordCase = wordCase;
}
- /** @return whether any of the added suggestions are considered "good" */
+ /**
+ * @return whether any of the added suggestions are considered "good"
+ */
boolean suggest() {
String low =
wordCase != WordCase.LOWER ? speller.dictionary.toLowerCase(misspelled) : misspelled;
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/morph/Token.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/morph/Token.java
index 7050e4e87e2..a1d1d74d54a 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/morph/Token.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/morph/Token.java
@@ -39,22 +39,30 @@ public abstract class Token {
this.type = type;
}
- /** @return surfaceForm */
+ /**
+ * @return surfaceForm
+ */
public char[] getSurfaceForm() {
return surfaceForm;
}
- /** @return offset into surfaceForm */
+ /**
+ * @return offset into surfaceForm
+ */
public int getOffset() {
return offset;
}
- /** @return length of surfaceForm */
+ /**
+ * @return length of surfaceForm
+ */
public int getLength() {
return length;
}
- /** @return surfaceForm as a String */
+ /**
+ * @return surfaceForm as a String
+ */
public String getSurfaceFormString() {
return new String(surfaceForm, offset, length);
}
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/pt/RSLPStemmerBase.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/pt/RSLPStemmerBase.java
index f9d550b012d..09be2d2503c 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/pt/RSLPStemmerBase.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/pt/RSLPStemmerBase.java
@@ -111,12 +111,16 @@ public abstract class RSLPStemmerBase {
this.min = min;
}
- /** @return true if the word matches this rule. */
+ /**
+ * @return true if the word matches this rule.
+ */
public boolean matches(char[] s, int len) {
return (len - suffix.length >= min && endsWith(s, len, suffix));
}
- /** @return new valid length of the string after firing this rule. */
+ /**
+ * @return new valid length of the string after firing this rule.
+ */
public int replace(char[] s, int len) {
if (replacement.length > 0) {
System.arraycopy(replacement, 0, s, len - suffix.length, replacement.length);
@@ -208,7 +212,9 @@ public abstract class RSLPStemmerBase {
}
}
- /** @return new valid length of the string after applying the entire step. */
+ /**
+ * @return new valid length of the string after applying the entire step.
+ */
public int apply(char[] s, int len) {
if (len < min) return len;
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/shingle/ShingleFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/shingle/ShingleFilter.java
index fb19974663b..1eb4357eef1 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/shingle/ShingleFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/shingle/ShingleFilter.java
@@ -532,7 +532,9 @@ public final class ShingleFilter extends TokenFilter {
return value == minValue;
}
- /** @return the value this instance had before the last advance() call */
+ /**
+ * @return the value this instance had before the last advance() call
+ */
public int getPreviousValue() {
return previousValue;
}
diff --git a/lucene/analysis/common/src/test/org/apache/lucene/analysis/synonym/TestMultiWordSynonyms.java b/lucene/analysis/common/src/test/org/apache/lucene/analysis/synonym/TestMultiWordSynonyms.java
index c1024c34104..681393d048e 100644
--- a/lucene/analysis/common/src/test/org/apache/lucene/analysis/synonym/TestMultiWordSynonyms.java
+++ b/lucene/analysis/common/src/test/org/apache/lucene/analysis/synonym/TestMultiWordSynonyms.java
@@ -23,7 +23,9 @@ import org.apache.lucene.tests.analysis.BaseTokenStreamFactoryTestCase;
import org.apache.lucene.tests.util.StringMockResourceLoader;
import org.apache.lucene.util.Version;
-/** @since solr 1.4 */
+/**
+ * @since solr 1.4
+ */
public class TestMultiWordSynonyms extends BaseTokenStreamFactoryTestCase {
public void testMultiWordSynonyms() throws Exception {
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ScriptIterator.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ScriptIterator.java
index 52a4aa436ae..68acfdfa4d0 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ScriptIterator.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ScriptIterator.java
@@ -62,7 +62,9 @@ final class ScriptIterator {
private final boolean combineCJ;
- /** @param combineCJ if true: Han,Hiragana,Katakana will all return as {@link UScript#JAPANESE} */
+ /**
+ * @param combineCJ if true: Han,Hiragana,Katakana will all return as {@link UScript#JAPANESE}
+ */
ScriptIterator(boolean combineCJ) {
this.combineCJ = combineCJ;
}
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/Token.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/Token.java
index 2de9e018329..7e5cfacf4be 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/Token.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/Token.java
@@ -58,32 +58,44 @@ public class Token extends org.apache.lucene.analysis.morph.Token {
+ ")";
}
- /** @return reading. null if token doesn't have reading. */
+ /**
+ * @return reading. null if token doesn't have reading.
+ */
public String getReading() {
return morphData.getReading(morphId, surfaceForm, offset, length);
}
- /** @return pronunciation. null if token doesn't have pronunciation. */
+ /**
+ * @return pronunciation. null if token doesn't have pronunciation.
+ */
public String getPronunciation() {
return morphData.getPronunciation(morphId, surfaceForm, offset, length);
}
- /** @return part of speech. */
+ /**
+ * @return part of speech.
+ */
public String getPartOfSpeech() {
return morphData.getPartOfSpeech(morphId);
}
- /** @return inflection type or null */
+ /**
+ * @return inflection type or null
+ */
public String getInflectionType() {
return morphData.getInflectionType(morphId);
}
- /** @return inflection form or null */
+ /**
+ * @return inflection form or null
+ */
public String getInflectionForm() {
return morphData.getInflectionForm(morphId);
}
- /** @return base form or null if token is not inflected */
+ /**
+ * @return base form or null if token is not inflected
+ */
public String getBaseForm() {
return morphData.getBaseForm(morphId, surfaceForm, offset, length);
}
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/TokenInfoFST.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/TokenInfoFST.java
index 23861585f4e..c96a2628df5 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/TokenInfoFST.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/TokenInfoFST.java
@@ -34,7 +34,9 @@ public final class TokenInfoFST extends org.apache.lucene.analysis.morph.TokenIn
super(fst, fasterButMoreRam ? 0x9FFF : 0x30FF, 0x3040);
}
- /** @lucene.internal for testing only */
+ /**
+ * @lucene.internal for testing only
+ */
FST<Long> getInternalFST() {
return fst;
}
diff --git a/lucene/analysis/nori/src/java/org/apache/lucene/analysis/ko/dict/TokenInfoFST.java b/lucene/analysis/nori/src/java/org/apache/lucene/analysis/ko/dict/TokenInfoFST.java
index 806f1209772..fa591eb0043 100644
--- a/lucene/analysis/nori/src/java/org/apache/lucene/analysis/ko/dict/TokenInfoFST.java
+++ b/lucene/analysis/nori/src/java/org/apache/lucene/analysis/ko/dict/TokenInfoFST.java
@@ -26,7 +26,9 @@ public final class TokenInfoFST extends org.apache.lucene.analysis.morph.TokenIn
super(fst, 0xD7A3, 0xAC00);
}
- /** @lucene.internal for testing only */
+ /**
+ * @lucene.internal for testing only
+ */
FST<Long> getInternalFST() {
return fst;
}
diff --git a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/PathNode.java b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/PathNode.java
index b08be464e2f..296b0ae57f4 100644
--- a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/PathNode.java
+++ b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/PathNode.java
@@ -35,7 +35,9 @@ class PathNode implements Comparable<PathNode> {
else return 1;
}
- /** @see java.lang.Object#hashCode() */
+ /**
+ * @see java.lang.Object#hashCode()
+ */
@Override
public int hashCode() {
final int prime = 31;
@@ -47,7 +49,9 @@ class PathNode implements Comparable<PathNode> {
return result;
}
- /** @see java.lang.Object#equals(java.lang.Object) */
+ /**
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
diff --git a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegToken.java b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegToken.java
index 3e03bbd036d..50a9a75f1e9 100644
--- a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegToken.java
+++ b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegToken.java
@@ -60,7 +60,9 @@ public class SegToken {
this.weight = weight;
}
- /** @see java.lang.Object#hashCode() */
+ /**
+ * @see java.lang.Object#hashCode()
+ */
@Override
public int hashCode() {
final int prime = 31;
@@ -76,7 +78,9 @@ public class SegToken {
return result;
}
- /** @see java.lang.Object#equals(java.lang.Object) */
+ /**
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
diff --git a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegTokenPair.java b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegTokenPair.java
index 59b4d5da767..cf400f8e5b0 100644
--- a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegTokenPair.java
+++ b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/SegTokenPair.java
@@ -42,7 +42,9 @@ class SegTokenPair {
this.weight = weight;
}
- /** @see java.lang.Object#hashCode() */
+ /**
+ * @see java.lang.Object#hashCode()
+ */
@Override
public int hashCode() {
final int prime = 31;
@@ -58,7 +60,9 @@ class SegTokenPair {
return result;
}
- /** @see java.lang.Object#equals(java.lang.Object) */
+ /**
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsReader.java
index 97a726dc639..71c3ea7d52e 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsReader.java
@@ -262,7 +262,9 @@ public final class Lucene50CompressingStoredFieldsReader extends StoredFieldsRea
}
}
- /** @throws AlreadyClosedException if this FieldsReader is closed */
+ /**
+ * @throws AlreadyClosedException if this FieldsReader is closed
+ */
private void ensureOpen() throws AlreadyClosedException {
if (closed) {
throw new AlreadyClosedException("this FieldsReader is closed");
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsReader.java
index f4977938bd6..cde22da5f95 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsReader.java
@@ -254,7 +254,9 @@ public final class Lucene50CompressingTermVectorsReader extends TermVectorsReade
}
}
- /** @throws AlreadyClosedException if this TermVectorsReader is closed */
+ /**
+ * @throws AlreadyClosedException if this TermVectorsReader is closed
+ */
private void ensureOpen() throws AlreadyClosedException {
if (closed) {
throw new AlreadyClosedException("this FieldsReader is closed");
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/Benchmark.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/Benchmark.java
index 5a77ffbdfc7..c7ac6ebb2f4 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/Benchmark.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/Benchmark.java
@@ -132,12 +132,16 @@ public class Benchmark {
System.out.println("####################");
}
- /** @return Returns the algorithm. */
+ /**
+ * @return Returns the algorithm.
+ */
public Algorithm getAlgorithm() {
return algorithm;
}
- /** @return Returns the runData. */
+ /**
+ * @return Returns the runData.
+ */
public PerfRunData getRunData() {
return runData;
}
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/PerfRunData.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/PerfRunData.java
index 0cb4cb92a0f..581898cd904 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/PerfRunData.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/PerfRunData.java
@@ -258,27 +258,37 @@ public class PerfRunData implements Closeable {
return startTimeMillis;
}
- /** @return Start time in milliseconds */
+ /**
+ * @return Start time in milliseconds
+ */
public long getStartTimeMillis() {
return startTimeMillis;
}
- /** @return Returns the points. */
+ /**
+ * @return Returns the points.
+ */
public Points getPoints() {
return points;
}
- /** @return Returns the directory. */
+ /**
+ * @return Returns the directory.
+ */
public Directory getDirectory() {
return directory;
}
- /** @param directory The directory to set. */
+ /**
+ * @param directory The directory to set.
+ */
public void setDirectory(Directory directory) {
this.directory = directory;
}
- /** @return Returns the taxonomy directory */
+ /**
+ * @return Returns the taxonomy directory
+ */
public Directory getTaxonomyDir() {
return taxonomyDir;
}
@@ -315,7 +325,9 @@ public class PerfRunData implements Closeable {
return taxonomyReader;
}
- /** @param taxoWriter The taxonomy writer to set. */
+ /**
+ * @param taxoWriter The taxonomy writer to set.
+ */
public void setTaxonomyWriter(TaxonomyWriter taxoWriter) {
this.taxonomyWriter = taxoWriter;
}
@@ -376,17 +388,23 @@ public class PerfRunData implements Closeable {
}
}
- /** @return Returns the indexWriter. */
+ /**
+ * @return Returns the indexWriter.
+ */
public IndexWriter getIndexWriter() {
return indexWriter;
}
- /** @param indexWriter The indexWriter to set. */
+ /**
+ * @param indexWriter The indexWriter to set.
+ */
public void setIndexWriter(IndexWriter indexWriter) {
this.indexWriter = indexWriter;
}
- /** @return Returns the analyzer. */
+ /**
+ * @return Returns the analyzer.
+ */
public Analyzer getAnalyzer() {
return analyzer;
}
@@ -410,17 +428,23 @@ public class PerfRunData implements Closeable {
return facetSource;
}
- /** @return the locale */
+ /**
+ * @return the locale
+ */
public Locale getLocale() {
return locale;
}
- /** @param locale the locale to set */
+ /**
+ * @param locale the locale to set
+ */
public void setLocale(Locale locale) {
this.locale = locale;
}
- /** @return Returns the config. */
+ /**
+ * @return Returns the config.
+ */
public Config getConfig() {
return config;
}
@@ -440,7 +464,9 @@ public class PerfRunData implements Closeable {
}
}
- /** @return Returns the queryMaker by read task type (class) */
+ /**
+ * @return Returns the queryMaker by read task type (class)
+ */
public synchronized QueryMaker getQueryMaker(ReadTask readTask) {
// mapping the query maker by task class allows extending/adding new search/read tasks
// without needing to modify this class.
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/stats/TaskStats.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/stats/TaskStats.java
index 6b4cfe0afad..3fc86501040 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/stats/TaskStats.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/stats/TaskStats.java
@@ -103,7 +103,9 @@ public class TaskStats implements Cloneable {
return countsByTimeStepMSec;
}
- /** @return the taskRunNum. */
+ /**
+ * @return the taskRunNum.
+ */
public int getTaskRunNum() {
return taskRunNum;
}
@@ -121,37 +123,51 @@ public class TaskStats implements Cloneable {
return res.toString();
}
- /** @return Returns the count. */
+ /**
+ * @return Returns the count.
+ */
public int getCount() {
return count;
}
- /** @return elapsed time. */
+ /**
+ * @return elapsed time.
+ */
public long getElapsed() {
return elapsed;
}
- /** @return Returns the maxTotMem. */
+ /**
+ * @return Returns the maxTotMem.
+ */
public long getMaxTotMem() {
return maxTotMem;
}
- /** @return Returns the maxUsedMem. */
+ /**
+ * @return Returns the maxUsedMem.
+ */
public long getMaxUsedMem() {
return maxUsedMem;
}
- /** @return Returns the numParallelTasks. */
+ /**
+ * @return Returns the numParallelTasks.
+ */
public int getNumParallelTasks() {
return numParallelTasks;
}
- /** @return Returns the task. */
+ /**
+ * @return Returns the task.
+ */
public PerfTask getTask() {
return task;
}
- /** @return Returns the numRuns. */
+ /**
+ * @return Returns the numRuns.
+ */
public int getNumRuns() {
return numRuns;
}
@@ -196,7 +212,9 @@ public class TaskStats implements Cloneable {
return c;
}
- /** @return the round number. */
+ /**
+ * @return the round number.
+ */
public int getRound() {
return round;
}
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PerfTask.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PerfTask.java
index fa998ff16ac..52e8cdfcb7c 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PerfTask.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PerfTask.java
@@ -156,7 +156,9 @@ public abstract class PerfTask implements Cloneable {
*/
public abstract int doLogic() throws Exception;
- /** @return Returns the name. */
+ /**
+ * @return Returns the name.
+ */
public String getName() {
if (params == null) {
return name;
@@ -164,22 +166,30 @@ public abstract class PerfTask implements Cloneable {
return new StringBuilder(name).append('(').append(params).append(')').toString();
}
- /** @param name The name to set. */
+ /**
+ * @param name The name to set.
+ */
protected void setName(String name) {
this.name = name;
}
- /** @return Returns the run data. */
+ /**
+ * @return Returns the run data.
+ */
public PerfRunData getRunData() {
return runData;
}
- /** @return Returns the depth. */
+ /**
+ * @return Returns the depth.
+ */
public int getDepth() {
return depth;
}
- /** @param depth The depth to set. */
+ /**
+ * @param depth The depth to set.
+ */
public void setDepth(int depth) {
this.depth = depth;
}
@@ -209,7 +219,9 @@ public abstract class PerfTask implements Cloneable {
return sb.toString();
}
- /** @return Returns the maxDepthLogStart. */
+ /**
+ * @return Returns the maxDepthLogStart.
+ */
int getMaxDepthLogStart() {
return maxDepthLogStart;
}
@@ -285,7 +297,9 @@ public abstract class PerfTask implements Cloneable {
this.params = params;
}
- /** @return Returns the Params. */
+ /**
+ * @return Returns the Params.
+ */
public String getParams() {
return params;
}
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
index 0292b954b7f..afa8d7b4f67 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
@@ -83,12 +83,16 @@ public class TaskSequence extends PerfTask {
}
}
- /** @return Returns the parallel. */
+ /**
+ * @return Returns the parallel.
+ */
public boolean isParallel() {
return parallel;
}
- /** @return Returns the repetitions. */
+ /**
+ * @return Returns the repetitions.
+ */
public int getRepetitions() {
return repetitions;
}
@@ -100,7 +104,9 @@ public class TaskSequence extends PerfTask {
fixedTime = true;
}
- /** @param repetitions The repetitions to set. */
+ /**
+ * @param repetitions The repetitions to set.
+ */
public void setRepetitions(int repetitions) throws Exception {
fixedTime = false;
this.repetitions = repetitions;
@@ -112,7 +118,9 @@ public class TaskSequence extends PerfTask {
setSequenceName();
}
- /** @return Returns the parent. */
+ /**
+ * @return Returns the parent.
+ */
public TaskSequence getParent() {
return parent;
}
@@ -484,7 +492,9 @@ public class TaskSequence extends PerfTask {
return (perMin ? rate : 60 * rate);
}
- /** @param rate The rate to set. */
+ /**
+ * @param rate The rate to set.
+ */
public void setRate(int rate, boolean perMin) {
this.rate = rate;
this.perMin = perMin;
@@ -511,7 +521,9 @@ public class TaskSequence extends PerfTask {
return seqName; // override to include more info
}
- /** @return Returns the tasks. */
+ /**
+ * @return Returns the tasks.
+ */
public ArrayList<PerfTask> getTasks() {
return tasks;
}
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
index 041f5e43838..33f3db560e4 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
@@ -389,7 +389,9 @@ public class Config {
return res;
}
- /** @return names of params set by round, for reports title */
+ /**
+ * @return names of params set by round, for reports title
+ */
public String getColsNamesForValsByRound() {
if (colForValByRound.size() == 0) {
return "";
@@ -401,7 +403,9 @@ public class Config {
return sb.toString();
}
- /** @return values of params set by round, for reports lines. */
+ /**
+ * @return values of params set by round, for reports lines.
+ */
public String getColsValuesForValsByRound(int roundNum) {
if (colForValByRound.size() == 0) {
return "";
@@ -440,12 +444,16 @@ public class Config {
return sb.toString();
}
- /** @return the round number. */
+ /**
+ * @return the round number.
+ */
public int getRoundNumber() {
return roundNumber;
}
- /** @return Returns the algorithmText. */
+ /**
+ * @return Returns the algorithmText.
+ */
public String getAlgorithmText() {
return algorithmText;
}
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/QualityBenchmark.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/QualityBenchmark.java
index 0b3eacb4484..fa741858eeb 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/QualityBenchmark.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/QualityBenchmark.java
@@ -142,7 +142,9 @@ public class QualityBenchmark {
return stts;
}
- /** @return the maximum number of quality queries to run. Useful at debugging. */
+ /**
+ * @return the maximum number of quality queries to run. Useful at debugging.
+ */
public int getMaxQueries() {
return maxQueries;
}
@@ -152,7 +154,9 @@ public class QualityBenchmark {
this.maxQueries = maxQueries;
}
- /** @return the maximum number of results to collect for each quality query. */
+ /**
+ * @return the maximum number of results to collect for each quality query.
+ */
public int getMaxResults() {
return maxResults;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/BlockHeader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/BlockHeader.java
index 986d59d3c9b..8ac3b376aea 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/BlockHeader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/BlockHeader.java
@@ -99,17 +99,23 @@ public class BlockHeader implements Accountable {
return this;
}
- /** @return The number of lines in the block. */
+ /**
+ * @return The number of lines in the block.
+ */
public int getLinesCount() {
return linesCount;
}
- /** @return The index of the middle line of the block. */
+ /**
+ * @return The index of the middle line of the block.
+ */
public int getMiddleLineIndex() {
return middleLineIndex;
}
- /** @return The offset to the middle line of the block, relative to the block start. */
+ /**
+ * @return The offset to the middle line of the block, relative to the block start.
+ */
public int getMiddleLineOffset() {
return middleLineOffset;
}
@@ -122,17 +128,23 @@ public class BlockHeader implements Accountable {
return termStatesBaseOffset;
}
- /** @return The file pointer to the docs of the first term with docs in the block. */
+ /**
+ * @return The file pointer to the docs of the first term with docs in the block.
+ */
public long getBaseDocsFP() {
return baseDocsFP;
}
- /** @return The file pointer to the positions of the first term with positions in the block. */
+ /**
+ * @return The file pointer to the positions of the first term with positions in the block.
+ */
public long getBasePositionsFP() {
return basePositionsFP;
}
- /** @return The file pointer to the payloads of the first term with payloads in the block. */
+ /**
+ * @return The file pointer to the payloads of the first term with payloads in the block.
+ */
public long getBasePayloadsFP() {
return basePayloadsFP;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/DeltaBaseTermStateSerializer.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/DeltaBaseTermStateSerializer.java
index 458c6c07cec..6881aedbd50 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/DeltaBaseTermStateSerializer.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/DeltaBaseTermStateSerializer.java
@@ -222,7 +222,9 @@ public class DeltaBaseTermStateSerializer implements Accountable {
return RAM_USAGE;
}
- /** @return The estimated RAM usage of the given {@link TermState}. */
+ /**
+ * @return The estimated RAM usage of the given {@link TermState}.
+ */
public static long ramBytesUsed(TermState termState) {
return termState instanceof IntBlockTermState
? INT_BLOCK_TERM_STATE_RAM_USAGE
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/FieldMetadata.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/FieldMetadata.java
index bdff1c0de3c..478e39fbf3b 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/FieldMetadata.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/FieldMetadata.java
@@ -139,7 +139,9 @@ public class FieldMetadata {
return isMutable ? docsSeen.cardinality() : docCount;
}
- /** @return The file pointer to the start of the first block of the field. */
+ /**
+ * @return The file pointer to the start of the first block of the field.
+ */
public long getFirstBlockStartFP() {
return firstBlockStartFP;
}
@@ -150,7 +152,9 @@ public class FieldMetadata {
this.firstBlockStartFP = firstBlockStartFP;
}
- /** @return The start file pointer for the last block of the field. */
+ /**
+ * @return The start file pointer for the last block of the field.
+ */
public long getLastBlockStartFP() {
return lastBlockStartFP;
}
@@ -161,7 +165,9 @@ public class FieldMetadata {
this.lastBlockStartFP = lastBlockStartFP;
}
- /** @return The file pointer to the start of the dictionary of the field. */
+ /**
+ * @return The file pointer to the start of the dictionary of the field.
+ */
public long getDictionaryStartFP() {
return dictionaryStartFP;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/IntersectBlockReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/IntersectBlockReader.java
index 22559af0127..dbf3bad6044 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/IntersectBlockReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/IntersectBlockReader.java
@@ -403,7 +403,9 @@ public class IntersectBlockReader extends BlockReader {
return linear && term.compareTo(linearUpperBound) < 0;
}
- /** @see org.apache.lucene.index.FilteredTermsEnum#nextSeekTerm(BytesRef) */
+ /**
+ * @see org.apache.lucene.index.FilteredTermsEnum#nextSeekTerm(BytesRef)
+ */
protected BytesRef nextSeekTerm(final BytesRef term) {
// System.out.println("ATE.nextSeekTerm term=" + term);
if (term == null) {
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/TermBytes.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/TermBytes.java
index 489e7ab287b..aa31121430c 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/TermBytes.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/TermBytes.java
@@ -79,7 +79,9 @@ public class TermBytes implements Accountable {
return mdpLength;
}
- /** @return This term bytes. */
+ /**
+ * @return This term bytes.
+ */
public BytesRef getTerm() {
return term;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitPostingsFormat.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitPostingsFormat.java
index c3ccd50e1aa..d89d64f5e68 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitPostingsFormat.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitPostingsFormat.java
@@ -90,7 +90,9 @@ public class UniformSplitPostingsFormat extends PostingsFormat {
this(NAME, targetNumBlockLines, deltaNumLines, blockEncoder, blockDecoder, dictionaryOnHeap);
}
- /** @see #UniformSplitPostingsFormat(int, int, BlockEncoder, BlockDecoder, boolean) */
+ /**
+ * @see #UniformSplitPostingsFormat(int, int, BlockEncoder, BlockDecoder, boolean)
+ */
protected UniformSplitPostingsFormat(
String name,
int targetNumBlockLines,
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsReader.java
index 9605ad18cbf..18e1dba0325 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsReader.java
@@ -90,7 +90,9 @@ public class UniformSplitTermsReader extends FieldsProducer {
TERMS_DICTIONARY_EXTENSION);
}
- /** @see #UniformSplitTermsReader(PostingsReaderBase, SegmentReadState, BlockDecoder, boolean) */
+ /**
+ * @see #UniformSplitTermsReader(PostingsReaderBase, SegmentReadState, BlockDecoder, boolean)
+ */
protected UniformSplitTermsReader(
PostingsReaderBase postingsReader,
SegmentReadState state,
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsWriter.java b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsWriter.java
index 6022dac13f1..f589b3ce7e5 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsWriter.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/uniformsplit/UniformSplitTermsWriter.java
@@ -305,7 +305,9 @@ public class UniformSplitTermsWriter extends FieldsConsumer {
encodedBytes.writeTo(blockOutput);
}
- /** @return 1 if the field was written; 0 otherwise. */
+ /**
+ * @return 1 if the field was written; 0 otherwise.
+ */
protected int writeFieldTerms(
BlockWriter blockWriter,
DataOutput fieldsOutput,
diff --git a/lucene/core/src/java/org/apache/lucene/analysis/Tokenizer.java b/lucene/core/src/java/org/apache/lucene/analysis/Tokenizer.java
index 1e30737ce4a..4cf8dc641b0 100644
--- a/lucene/core/src/java/org/apache/lucene/analysis/Tokenizer.java
+++ b/lucene/core/src/java/org/apache/lucene/analysis/Tokenizer.java
@@ -103,7 +103,9 @@ public abstract class Tokenizer extends TokenStream {
inputPending = ILLEGAL_STATE_READER;
}
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
protected void setReaderTestPoint() {}
private static final Reader ILLEGAL_STATE_READER =
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsReader.java
index 34cdfad6f43..159837b11b1 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsReader.java
@@ -217,7 +217,9 @@ public final class Lucene90CompressingStoredFieldsReader extends StoredFieldsRea
}
}
- /** @throws AlreadyClosedException if this FieldsReader is closed */
+ /**
+ * @throws AlreadyClosedException if this FieldsReader is closed
+ */
private void ensureOpen() throws AlreadyClosedException {
if (closed) {
throw new AlreadyClosedException("this FieldsReader is closed");
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
index b44c1cddfee..440b44e07cb 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
@@ -284,7 +284,9 @@ public final class Lucene90CompressingTermVectorsReader extends TermVectorsReade
return numDocs;
}
- /** @throws AlreadyClosedException if this TermVectorsReader is closed */
+ /**
+ * @throws AlreadyClosedException if this TermVectorsReader is closed
+ */
private void ensureOpen() throws AlreadyClosedException {
if (closed) {
throw new AlreadyClosedException("this FieldsReader is closed");
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene94/ExpandingVectorValues.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene94/ExpandingVectorValues.java
index 6193582162e..292ef6e09e0 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene94/ExpandingVectorValues.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene94/ExpandingVectorValues.java
@@ -27,7 +27,9 @@ public class ExpandingVectorValues extends FilterVectorValues {
private final float[] value;
- /** @param in the wrapped values */
+ /**
+ * @param in the wrapped values
+ */
protected ExpandingVectorValues(VectorValues in) {
super(in);
value = new float[in.dimension()];
diff --git a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterFlushQueue.java b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterFlushQueue.java
index ebbaa8271e9..235dbb1fbd4 100644
--- a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterFlushQueue.java
+++ b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterFlushQueue.java
@@ -24,7 +24,9 @@ import java.util.concurrent.locks.ReentrantLock;
import org.apache.lucene.index.DocumentsWriterPerThread.FlushedSegment;
import org.apache.lucene.util.IOConsumer;
-/** @lucene.internal */
+/**
+ * @lucene.internal
+ */
final class DocumentsWriterFlushQueue {
private final Queue<FlushTicket> queue = new ArrayDeque<>();
// we track tickets separately since count must be present even before the ticket is
diff --git a/lucene/core/src/java/org/apache/lucene/index/LiveIndexWriterConfig.java b/lucene/core/src/java/org/apache/lucene/index/LiveIndexWriterConfig.java
index 21e84b647f4..257c429818c 100644
--- a/lucene/core/src/java/org/apache/lucene/index/LiveIndexWriterConfig.java
+++ b/lucene/core/src/java/org/apache/lucene/index/LiveIndexWriterConfig.java
@@ -343,7 +343,9 @@ public class LiveIndexWriterConfig {
return perThreadHardLimitMB;
}
- /** @see IndexWriterConfig#setFlushPolicy(FlushPolicy) */
+ /**
+ * @see IndexWriterConfig#setFlushPolicy(FlushPolicy)
+ */
FlushPolicy getFlushPolicy() {
return flushPolicy;
}
diff --git a/lucene/core/src/java/org/apache/lucene/search/DisjunctionMaxQuery.java b/lucene/core/src/java/org/apache/lucene/search/DisjunctionMaxQuery.java
index 2ca65769735..fdfe314da12 100644
--- a/lucene/core/src/java/org/apache/lucene/search/DisjunctionMaxQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/DisjunctionMaxQuery.java
@@ -68,18 +68,24 @@ public final class DisjunctionMaxQuery extends Query implements Iterable<Query>
this.disjuncts.addAll(disjuncts);
}
- /** @return An {@code Iterator<Query>} over the disjuncts */
+ /**
+ * @return An {@code Iterator<Query>} over the disjuncts
+ */
@Override
public Iterator<Query> iterator() {
return getDisjuncts().iterator();
}
- /** @return the disjuncts. */
+ /**
+ * @return the disjuncts.
+ */
public Collection<Query> getDisjuncts() {
return Collections.unmodifiableCollection(disjuncts);
}
- /** @return tie breaker value for multiple matches. */
+ /**
+ * @return tie breaker value for multiple matches.
+ */
public float getTieBreakerMultiplier() {
return tieBreakerMultiplier;
}
diff --git a/lucene/core/src/java/org/apache/lucene/search/FuzzyQuery.java b/lucene/core/src/java/org/apache/lucene/search/FuzzyQuery.java
index 4515c2df45d..2186538500b 100644
--- a/lucene/core/src/java/org/apache/lucene/search/FuzzyQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/FuzzyQuery.java
@@ -144,7 +144,9 @@ public class FuzzyQuery extends MultiTermQuery {
this(term, defaultMaxEdits);
}
- /** @return the maximum number of edit distances allowed for this query to match. */
+ /**
+ * @return the maximum number of edit distances allowed for this query to match.
+ */
public int getMaxEdits() {
return maxEdits;
}
diff --git a/lucene/core/src/java/org/apache/lucene/search/MultiTermQuery.java b/lucene/core/src/java/org/apache/lucene/search/MultiTermQuery.java
index 8a00a1efe0f..363a508aca4 100644
--- a/lucene/core/src/java/org/apache/lucene/search/MultiTermQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/MultiTermQuery.java
@@ -283,7 +283,9 @@ public abstract class MultiTermQuery extends Query {
return rewriteMethod.rewrite(reader, this);
}
- /** @return the rewrite method used to build the final query */
+ /**
+ * @return the rewrite method used to build the final query
+ */
public RewriteMethod getRewriteMethod() {
return rewriteMethod;
}
diff --git a/lucene/core/src/java/org/apache/lucene/search/SegmentCacheable.java b/lucene/core/src/java/org/apache/lucene/search/SegmentCacheable.java
index 2ed95a65c49..8a9aecb7d3e 100644
--- a/lucene/core/src/java/org/apache/lucene/search/SegmentCacheable.java
+++ b/lucene/core/src/java/org/apache/lucene/search/SegmentCacheable.java
@@ -36,6 +36,8 @@ import org.apache.lucene.index.LeafReaderContext;
*/
public interface SegmentCacheable {
- /** @return {@code true} if the object can be cached against a given leaf */
+ /**
+ * @return {@code true} if the object can be cached against a given leaf
+ */
boolean isCacheable(LeafReaderContext ctx);
}
diff --git a/lucene/core/src/java/org/apache/lucene/store/ByteBuffersDataOutput.java b/lucene/core/src/java/org/apache/lucene/store/ByteBuffersDataOutput.java
index 84a7b317d88..5c12536f254 100644
--- a/lucene/core/src/java/org/apache/lucene/store/ByteBuffersDataOutput.java
+++ b/lucene/core/src/java/org/apache/lucene/store/ByteBuffersDataOutput.java
@@ -344,7 +344,9 @@ public final class ByteBuffersDataOutput extends DataOutput implements Accountab
}
}
- /** @return The number of bytes written to this output so far. */
+ /**
+ * @return The number of bytes written to this output so far.
+ */
public long size() {
long size = 0;
int blockCount = blocks.size();
@@ -477,7 +479,9 @@ public final class ByteBuffersDataOutput extends DataOutput implements Accountab
currentBlock = EMPTY;
}
- /** @return Returns a new {@link ByteBuffersDataOutput} with the {@link #reset()} capability. */
+ /**
+ * @return Returns a new {@link ByteBuffersDataOutput} with the {@link #reset()} capability.
+ */
// TODO: perhaps we can move it out to an utility class (as a supplier of preconfigured
// instances?)
public static ByteBuffersDataOutput newResettableInstance() {
diff --git a/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java b/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
index 965268a5c00..f36a651b16b 100644
--- a/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
@@ -286,7 +286,9 @@ public abstract class FSDirectory extends BaseDirectory {
deletePendingFiles();
}
- /** @return the underlying filesystem directory */
+ /**
+ * @return the underlying filesystem directory
+ */
public Path getDirectory() {
ensureOpen();
return directory;
diff --git a/lucene/core/src/java/org/apache/lucene/util/CharsRef.java b/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
index 395bd865330..0cb73ff5597 100644
--- a/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
+++ b/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
@@ -147,18 +147,24 @@ public final class CharsRef implements Comparable<CharsRef>, CharSequence, Clone
return new CharsRef(chars, offset + start, end - start);
}
- /** @deprecated This comparator is only a transition mechanism */
+ /**
+ * @deprecated This comparator is only a transition mechanism
+ */
@Deprecated
private static final Comparator<CharsRef> utf16SortedAsUTF8SortOrder =
new UTF16SortedAsUTF8Comparator();
- /** @deprecated This comparator is only a transition mechanism */
+ /**
+ * @deprecated This comparator is only a transition mechanism
+ */
@Deprecated
public static Comparator<CharsRef> getUTF16SortedAsUTF8Comparator() {
return utf16SortedAsUTF8SortOrder;
}
- /** @deprecated This comparator is only a transition mechanism */
+ /**
+ * @deprecated This comparator is only a transition mechanism
+ */
@Deprecated
private static class UTF16SortedAsUTF8Comparator implements Comparator<CharsRef> {
// Only singleton
diff --git a/lucene/core/src/java/org/apache/lucene/util/MapOfSets.java b/lucene/core/src/java/org/apache/lucene/util/MapOfSets.java
index 982f0a99223..eef74b7f69f 100644
--- a/lucene/core/src/java/org/apache/lucene/util/MapOfSets.java
+++ b/lucene/core/src/java/org/apache/lucene/util/MapOfSets.java
@@ -31,12 +31,16 @@ public class MapOfSets<K, V> {
private final Map<K, Set<V>> theMap;
- /** @param m the backing store for this object */
+ /**
+ * @param m the backing store for this object
+ */
public MapOfSets(Map<K, Set<V>> m) {
theMap = m;
}
- /** @return direct access to the map backing this object. */
+ /**
+ * @return direct access to the map backing this object.
+ */
public Map<K, Set<V>> getMap() {
return theMap;
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java b/lucene/core/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java
index 4f373c8fe25..c1d177d313f 100644
--- a/lucene/core/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java
+++ b/lucene/core/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java
@@ -99,17 +99,23 @@ public final class RecyclingByteBlockAllocator extends ByteBlockPool.Allocator {
assert bytesUsed.get() >= 0;
}
- /** @return the number of currently buffered blocks */
+ /**
+ * @return the number of currently buffered blocks
+ */
public int numBufferedBlocks() {
return freeBlocks;
}
- /** @return the number of bytes currently allocated by this {@link Allocator} */
+ /**
+ * @return the number of bytes currently allocated by this {@link Allocator}
+ */
public long bytesUsed() {
return bytesUsed.get();
}
- /** @return the maximum number of buffered byte blocks */
+ /**
+ * @return the maximum number of buffered byte blocks
+ */
public int maxBufferedBlocks() {
return maxBufferedBlocks;
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java b/lucene/core/src/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java
index 6818bdf0e37..06111be44ec 100644
--- a/lucene/core/src/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java
+++ b/lucene/core/src/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java
@@ -99,17 +99,23 @@ public final class RecyclingIntBlockAllocator extends Allocator {
assert bytesUsed.get() >= 0;
}
- /** @return the number of currently buffered blocks */
+ /**
+ * @return the number of currently buffered blocks
+ */
public int numBufferedBlocks() {
return freeBlocks;
}
- /** @return the number of bytes currently allocated by this {@link Allocator} */
+ /**
+ * @return the number of bytes currently allocated by this {@link Allocator}
+ */
public long bytesUsed() {
return bytesUsed.get();
}
- /** @return the maximum number of buffered byte blocks */
+ /**
+ * @return the maximum number of buffered byte blocks
+ */
public int maxBufferedBlocks() {
return maxBufferedBlocks;
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/Version.java b/lucene/core/src/java/org/apache/lucene/util/Version.java
index b583bdb7fca..f5e9de658b3 100644
--- a/lucene/core/src/java/org/apache/lucene/util/Version.java
+++ b/lucene/core/src/java/org/apache/lucene/util/Version.java
@@ -95,7 +95,9 @@ public final class Version {
*/
public static final int MIN_SUPPORTED_MAJOR = Version.LATEST.major - 1;
- /** @see #getPackageImplementationVersion() */
+ /**
+ * @see #getPackageImplementationVersion()
+ */
private static String implementationVersion;
/**
diff --git a/lucene/core/src/java/org/apache/lucene/util/fst/FST.java b/lucene/core/src/java/org/apache/lucene/util/fst/FST.java
index 2ccaa937286..c87dcc3a300 100644
--- a/lucene/core/src/java/org/apache/lucene/util/fst/FST.java
+++ b/lucene/core/src/java/org/apache/lucene/util/fst/FST.java
@@ -94,13 +94,19 @@ public final class FST<T> implements Accountable {
*/
static final byte ARCS_FOR_DIRECT_ADDRESSING = 1 << 6;
- /** @see #shouldExpandNodeWithFixedLengthArcs */
+ /**
+ * @see #shouldExpandNodeWithFixedLengthArcs
+ */
static final int FIXED_LENGTH_ARC_SHALLOW_DEPTH = 3; // 0 => only root node.
- /** @see #shouldExpandNodeWithFixedLengthArcs */
+ /**
+ * @see #shouldExpandNodeWithFixedLengthArcs
+ */
static final int FIXED_LENGTH_ARC_SHALLOW_NUM_ARCS = 5;
- /** @see #shouldExpandNodeWithFixedLengthArcs */
+ /**
+ * @see #shouldExpandNodeWithFixedLengthArcs
+ */
static final int FIXED_LENGTH_ARC_DEEP_NUM_ARCS = 10;
/**
diff --git a/lucene/core/src/java/org/apache/lucene/util/hnsw/NeighborQueue.java b/lucene/core/src/java/org/apache/lucene/util/hnsw/NeighborQueue.java
index 50f0587bb5c..bcc43435872 100644
--- a/lucene/core/src/java/org/apache/lucene/util/hnsw/NeighborQueue.java
+++ b/lucene/core/src/java/org/apache/lucene/util/hnsw/NeighborQueue.java
@@ -61,7 +61,9 @@ public class NeighborQueue {
this.order = maxHeap ? Order.MAX_HEAP : Order.MIN_HEAP;
}
- /** @return the number of elements in the heap */
+ /**
+ * @return the number of elements in the heap
+ */
public int size() {
return heap.size();
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/hppc/IntIntHashMap.java b/lucene/core/src/java/org/apache/lucene/util/hppc/IntIntHashMap.java
index e7876f890f3..95d5a17c7dd 100644
--- a/lucene/core/src/java/org/apache/lucene/util/hppc/IntIntHashMap.java
+++ b/lucene/core/src/java/org/apache/lucene/util/hppc/IntIntHashMap.java
@@ -563,7 +563,9 @@ public class IntIntHashMap implements Iterable<IntIntHashMap.IntIntCursor>, Clon
}
}
- /** @return Returns a container with all values stored in this map. */
+ /**
+ * @return Returns a container with all values stored in this map.
+ */
public IntContainer values() {
return new ValuesContainer();
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java b/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
index e74e5292d41..70771b22ecc 100644
--- a/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
+++ b/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
@@ -393,7 +393,9 @@ public class PackedInts {
return gets;
}
- /** @return the number of values. */
+ /**
+ * @return the number of values.
+ */
public abstract int size();
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/packed/PackedLongValues.java b/lucene/core/src/java/org/apache/lucene/util/packed/PackedLongValues.java
index b028e2398e5..94abe242a32 100644
--- a/lucene/core/src/java/org/apache/lucene/util/packed/PackedLongValues.java
+++ b/lucene/core/src/java/org/apache/lucene/util/packed/PackedLongValues.java
@@ -41,7 +41,9 @@ public class PackedLongValues extends LongValues implements Accountable {
return new PackedLongValues.Builder(pageSize, acceptableOverheadRatio);
}
- /** @see #packedBuilder(int, float) */
+ /**
+ * @see #packedBuilder(int, float)
+ */
public static PackedLongValues.Builder packedBuilder(float acceptableOverheadRatio) {
return packedBuilder(DEFAULT_PAGE_SIZE, acceptableOverheadRatio);
}
@@ -55,7 +57,9 @@ public class PackedLongValues extends LongValues implements Accountable {
return new DeltaPackedLongValues.Builder(pageSize, acceptableOverheadRatio);
}
- /** @see #deltaPackedBuilder(int, float) */
+ /**
+ * @see #deltaPackedBuilder(int, float)
+ */
public static PackedLongValues.Builder deltaPackedBuilder(float acceptableOverheadRatio) {
return deltaPackedBuilder(DEFAULT_PAGE_SIZE, acceptableOverheadRatio);
}
@@ -69,7 +73,9 @@ public class PackedLongValues extends LongValues implements Accountable {
return new MonotonicLongValues.Builder(pageSize, acceptableOverheadRatio);
}
- /** @see #monotonicBuilder(int, float) */
+ /**
+ * @see #monotonicBuilder(int, float)
+ */
public static PackedLongValues.Builder monotonicBuilder(float acceptableOverheadRatio) {
return monotonicBuilder(DEFAULT_PAGE_SIZE, acceptableOverheadRatio);
}
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestOmitPositions.java b/lucene/core/src/test/org/apache/lucene/index/TestOmitPositions.java
index 46bf5adc8dc..cb0a8807746 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestOmitPositions.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestOmitPositions.java
@@ -29,7 +29,9 @@ import org.apache.lucene.tests.util.LuceneTestCase;
import org.apache.lucene.tests.util.TestUtil;
import org.apache.lucene.util.BytesRef;
-/** @lucene.experimental */
+/**
+ * @lucene.experimental
+ */
public class TestOmitPositions extends LuceneTestCase {
public void testBasic() throws Exception {
diff --git a/lucene/expressions/src/generated/checksums/generateAntlr.json b/lucene/expressions/src/generated/checksums/generateAntlr.json
index f4ba5046920..07c8d018e8a 100644
--- a/lucene/expressions/src/generated/checksums/generateAntlr.json
+++ b/lucene/expressions/src/generated/checksums/generateAntlr.json
@@ -1,7 +1,7 @@
{
"lucene/expressions/src/java/org/apache/lucene/expressions/js/Javascript.g4": "818e89aae0b6c7601051802013898c128fe7c1ba",
"lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptBaseVisitor.java": "45e3c7093f3e485a07be507efbdefc5e3d112576",
- "lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java": "f0a53549fb8329dd4181f836d1778417de08550e",
- "lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java": "ca9d587e6e98436647370ee5b7c82ae07243ee50",
+ "lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java": "354e2d7a982fec18a06e552438c2b2e2c13137cf",
+ "lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java": "6182b6a2e3ade663e6f7a8643ace313e66cbf12a",
"lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptVisitor.java": "ebf033dc72e63203e5d4d85fd57114dd973482dc"
}
\ No newline at end of file
diff --git a/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java b/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java
index 8a6af407f5b..4291bffa88c 100644
--- a/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java
+++ b/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptLexer.java
@@ -127,7 +127,9 @@ class JavascriptLexer extends Lexer {
};
public static final Vocabulary VOCABULARY = new VocabularyImpl(_LITERAL_NAMES, _SYMBOLIC_NAMES);
- /** @deprecated Use {@link #VOCABULARY} instead. */
+ /**
+ * @deprecated Use {@link #VOCABULARY} instead.
+ */
@Deprecated public static final String[] tokenNames;
static {
diff --git a/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java b/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java
index 99f4cdf1306..267927b5d1b 100644
--- a/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java
+++ b/lucene/expressions/src/java/org/apache/lucene/expressions/js/JavascriptParser.java
@@ -90,7 +90,9 @@ class JavascriptParser extends Parser {
};
public static final Vocabulary VOCABULARY = new VocabularyImpl(_LITERAL_NAMES, _SYMBOLIC_NAMES);
- /** @deprecated Use {@link #VOCABULARY} instead. */
+ /**
+ * @deprecated Use {@link #VOCABULARY} instead.
+ */
@Deprecated public static final String[] tokenNames;
static {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/directory/Consts.java b/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/directory/Consts.java
index e5256db380a..c52805c5df1 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/directory/Consts.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/directory/Consts.java
@@ -16,7 +16,9 @@
*/
package org.apache.lucene.facet.taxonomy.directory;
-/** @lucene.experimental */
+/**
+ * @lucene.experimental
+ */
abstract class Consts {
static final String FULL = "$full_path$";
static final String FIELD_PARENT_ORDINAL_NDV = "$parent_ndv$";
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/AllGroupHeadsCollector.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/AllGroupHeadsCollector.java
index 8bfe9f144f4..780090cd0bd 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/AllGroupHeadsCollector.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/AllGroupHeadsCollector.java
@@ -109,7 +109,9 @@ public abstract class AllGroupHeadsCollector<T> extends SimpleCollector {
return docHeads;
}
- /** @return the number of group heads found for a query. */
+ /**
+ * @return the number of group heads found for a query.
+ */
public int groupHeadsSize() {
return getCollectedGroupHeads().size();
}
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java
index 9bcda62592e..1f34f67a92e 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java
@@ -52,7 +52,9 @@ public class FirstPassGroupingCollector<T> extends SimpleCollector {
private final int compIDXEnd;
// Set once we reach topNGroups unique groups:
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
protected TreeSet<CollectedSearchGroup<T>> orderedGroups;
private int docBase;
@@ -353,7 +355,9 @@ public class FirstPassGroupingCollector<T> extends SimpleCollector {
groupSelector.setNextReader(readerContext);
}
- /** @return the GroupSelector used for this Collector */
+ /**
+ * @return the GroupSelector used for this Collector
+ */
public GroupSelector<T> getGroupSelector() {
return groupSelector;
}
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupFacetCollector.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupFacetCollector.java
index 5dfc0d2d4bb..74a957d809d 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupFacetCollector.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupFacetCollector.java
@@ -263,12 +263,16 @@ public abstract class GroupFacetCollector extends SimpleCollector {
return "FacetEntry{" + "value=" + value.utf8ToString() + ", count=" + count + '}';
}
- /** @return The value of this facet entry */
+ /**
+ * @return The value of this facet entry
+ */
public BytesRef getValue() {
return value;
}
- /** @return The count (number of groups) of this facet entry. */
+ /**
+ * @return The count (number of groups) of this facet entry.
+ */
public int getCount() {
return count;
}
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupSelector.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupSelector.java
index a5e4ddcf657..4c81073593b 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupSelector.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupSelector.java
@@ -55,7 +55,9 @@ public abstract class GroupSelector<T> {
*/
public abstract T currentValue() throws IOException;
- /** @return a copy of the group value of the current document */
+ /**
+ * @return a copy of the group value of the current document
+ */
public abstract T copyValue() throws IOException;
/**
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java
index 77cd049e62e..2000493f6e8 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java
@@ -66,7 +66,9 @@ public class SecondPassGroupingCollector<T> extends SimpleCollector {
reducer.setGroups(groups);
}
- /** @return the GroupSelector used in this collector */
+ /**
+ * @return the GroupSelector used in this collector
+ */
public GroupSelector<T> getGroupSelector() {
return groupSelector;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Encoder.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Encoder.java
index c181cc5e6fa..4bc749b68a6 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Encoder.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Encoder.java
@@ -18,6 +18,8 @@ package org.apache.lucene.search.highlight;
/** Encodes original text. The Encoder works with the {@link Formatter} to generate output. */
public interface Encoder {
- /** @param originalText The section of text being output */
+ /**
+ * @param originalText The section of text being output
+ */
String encodeText(String originalText);
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
index 311eb18fa57..cc5587ad50a 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
@@ -423,7 +423,9 @@ public class Highlighter {
textFragmenter = Objects.requireNonNull(fragmenter);
}
- /** @return Object used to score each text fragment */
+ /**
+ * @return Object used to score each text fragment
+ */
public Scorer getFragmentScorer() {
return fragmentScorer;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
index 09814ae8c67..3a46ff94733 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
@@ -53,7 +53,9 @@ public class QueryScorer implements Scorer {
private int maxCharsToAnalyze;
private boolean usePayloads = false;
- /** @param query Query to use for highlighting */
+ /**
+ * @param query Query to use for highlighting
+ */
public QueryScorer(Query query) {
init(query, null, null, true);
}
@@ -85,13 +87,17 @@ public class QueryScorer implements Scorer {
init(query, field, reader, true);
}
- /** @param defaultField - The default field for queries with the field name unspecified */
+ /**
+ * @param defaultField - The default field for queries with the field name unspecified
+ */
public QueryScorer(Query query, String field, String defaultField) {
this.defaultField = defaultField;
init(query, field, null, true);
}
- /** @param weightedTerms an array of pre-created {@link WeightedSpanTerm}s */
+ /**
+ * @param weightedTerms an array of pre-created {@link WeightedSpanTerm}s
+ */
public QueryScorer(WeightedSpanTerm[] weightedTerms) {
this.fieldWeightedSpanTerms = new HashMap<>(weightedTerms.length);
@@ -228,7 +234,9 @@ public class QueryScorer implements Scorer {
totalScore = 0;
}
- /** @return true if multi-term queries should be expanded */
+ /**
+ * @return true if multi-term queries should be expanded
+ */
public boolean isExpandMultiTermQuery() {
return expandMultiTermQuery;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleFragmenter.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleFragmenter.java
index c504918b87b..c0548ece27b 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleFragmenter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleFragmenter.java
@@ -33,7 +33,9 @@ public class SimpleFragmenter implements Fragmenter {
this(DEFAULT_FRAGMENT_SIZE);
}
- /** @param fragmentSize size in number of characters of each fragment */
+ /**
+ * @param fragmentSize size in number of characters of each fragment
+ */
public SimpleFragmenter(int fragmentSize) {
this.fragmentSize = fragmentSize;
}
@@ -59,12 +61,16 @@ public class SimpleFragmenter implements Fragmenter {
return isNewFrag;
}
- /** @return size in number of characters of each fragment */
+ /**
+ * @return size in number of characters of each fragment
+ */
public int getFragmentSize() {
return fragmentSize;
}
- /** @param size size in characters of each fragment */
+ /**
+ * @param size size in characters of each fragment
+ */
public void setFragmentSize(int size) {
fragmentSize = size;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleSpanFragmenter.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleSpanFragmenter.java
index d72930c1ea7..f41032e90db 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleSpanFragmenter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/SimpleSpanFragmenter.java
@@ -39,7 +39,9 @@ public class SimpleSpanFragmenter implements Fragmenter {
private PositionIncrementAttribute posIncAtt;
private OffsetAttribute offsetAtt;
- /** @param queryScorer QueryScorer that was used to score hits */
+ /**
+ * @param queryScorer QueryScorer that was used to score hits
+ */
public SimpleSpanFragmenter(QueryScorer queryScorer) {
this(queryScorer, DEFAULT_FRAGMENT_SIZE);
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
index 3ae4e9f2716..406f8f71cc4 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
@@ -36,17 +36,23 @@ public class TextFragment {
public float getScore() {
return score;
}
- /** @param frag2 Fragment to be merged into this one */
+ /**
+ * @param frag2 Fragment to be merged into this one
+ */
public void merge(TextFragment frag2) {
textEndPos = frag2.textEndPos;
score = Math.max(score, frag2.score);
}
- /** @return true if this fragment follows the one passed */
+ /**
+ * @return true if this fragment follows the one passed
+ */
public boolean follows(TextFragment fragment) {
return textStartPos == fragment.textEndPos;
}
- /** @return the fragment sequence number */
+ /**
+ * @return the fragment sequence number
+ */
public int getFragNum() {
return fragNum;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenGroup.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenGroup.java
index 96384abc34b..a25c2f0c3f7 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenGroup.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenGroup.java
@@ -103,12 +103,16 @@ public class TokenGroup {
return matchEndOffset;
}
- /** @return the number of tokens in this group */
+ /**
+ * @return the number of tokens in this group
+ */
public int getNumTokens() {
return numTokens;
}
- /** @return all tokens' scores summed up */
+ /**
+ * @return all tokens' scores summed up
+ */
public float getTotalScore() {
return tot;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedTerm.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedTerm.java
index adaad114799..c5feccdd79f 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedTerm.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedTerm.java
@@ -25,22 +25,30 @@ public class WeightedTerm {
this.term = term;
}
- /** @return the term value (stemmed) */
+ /**
+ * @return the term value (stemmed)
+ */
public String getTerm() {
return term;
}
- /** @return the weight associated with this term */
+ /**
+ * @return the weight associated with this term
+ */
public float getWeight() {
return weight;
}
- /** @param term the term value (stemmed) */
+ /**
+ * @param term the term value (stemmed)
+ */
public void setTerm(String term) {
this.term = term;
}
- /** @param weight the weight associated with this term */
+ /**
+ * @param weight the weight associated with this term
+ */
public void setWeight(float weight) {
this.weight = weight;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/matchhighlight/OffsetRange.java b/lucene/highlighter/src/java/org/apache/lucene/search/matchhighlight/OffsetRange.java
index 5123f34d64a..bdf2adeb732 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/matchhighlight/OffsetRange.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/matchhighlight/OffsetRange.java
@@ -71,7 +71,9 @@ public class OffsetRange implements Cloneable {
return new OffsetRange(from, to);
}
- /** @return {@code true} if this range contains or is equal to {@code other}. */
+ /**
+ * @return {@code true} if this range contains or is equal to {@code other}.
+ */
public boolean contains(OffsetRange other) {
return from <= other.from && to >= other.to;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/LabelledCharArrayMatcher.java b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/LabelledCharArrayMatcher.java
index ff96916f77c..f8ef7cc5a46 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/LabelledCharArrayMatcher.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/LabelledCharArrayMatcher.java
@@ -28,7 +28,9 @@ import org.apache.lucene.util.automaton.ByteRunAutomaton;
*/
public interface LabelledCharArrayMatcher extends CharArrayMatcher {
- /** @return the label for this matcher */
+ /**
+ * @return the label for this matcher
+ */
String getLabel();
/** Associates a label with a CharArrayMatcher */
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/Passage.java b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/Passage.java
index 6fa281bb16c..69ef36504ae 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/Passage.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/Passage.java
@@ -39,7 +39,9 @@ public class Passage {
private int[] matchTermFreqInDoc = new int[8];
private int numMatches = 0;
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
public void addMatch(int startOffset, int endOffset, BytesRef term, int termFreqInDoc) {
assert startOffset >= this.startOffset && startOffset <= this.endOffset;
if (numMatches == matchStarts.length) {
@@ -65,7 +67,9 @@ public class Passage {
numMatches++;
}
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
public void reset() {
startOffset = endOffset = -1;
score = 0.0f;
@@ -177,12 +181,16 @@ public class Passage {
return matchTermFreqInDoc;
}
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
public void setStartOffset(int startOffset) {
this.startOffset = startOffset;
}
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
public void setEndOffset(int endOffset) {
assert startOffset <= endOffset;
this.endOffset = endOffset;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/UnifiedHighlighter.java b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/UnifiedHighlighter.java
index f74babab3ae..2d76099ae1c 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/UnifiedHighlighter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/UnifiedHighlighter.java
@@ -1349,7 +1349,9 @@ public class UnifiedHighlighter {
return docListOfFields;
}
- /** @lucene.internal */
+ /**
+ * @lucene.internal
+ */
protected LimitedStoredFieldVisitor newLimitedStoredFieldsVisitor(String[] fields) {
return new LimitedStoredFieldVisitor(fields, MULTIVAL_SEP_CHAR, getMaxLength());
}
@@ -1481,16 +1483,24 @@ public class UnifiedHighlighter {
/** Flags for controlling highlighting behavior. */
public enum HighlightFlag {
- /** @see Builder#withHighlightPhrasesStrictly(boolean) */
+ /**
+ * @see Builder#withHighlightPhrasesStrictly(boolean)
+ */
PHRASES,
- /** @see Builder#withHandleMultiTermQuery(boolean) */
+ /**
+ * @see Builder#withHandleMultiTermQuery(boolean)
+ */
MULTI_TERM_QUERY,
- /** @see Builder#withPassageRelevancyOverSpeed(boolean) */
+ /**
+ * @see Builder#withPassageRelevancyOverSpeed(boolean)
+ */
PASSAGE_RELEVANCY_OVER_SPEED,
- /** @see Builder#withWeightMatches(boolean) */
+ /**
+ * @see Builder#withWeightMatches(boolean)
+ */
WEIGHT_MATCHES
// TODO: useQueryBoosts
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldPhraseList.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldPhraseList.java
index e71d3f569c2..ae3bd7b0357 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldPhraseList.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldPhraseList.java
@@ -205,17 +205,23 @@ public class FieldPhraseList {
return text.toString();
}
- /** @return the termsOffsets */
+ /**
+ * @return the termsOffsets
+ */
public List<Toffs> getTermsOffsets() {
return termsOffsets;
}
- /** @return the boost */
+ /**
+ * @return the boost
+ */
public float getBoost() {
return boost;
}
- /** @return the termInfos */
+ /**
+ * @return the termInfos
+ */
public List<TermInfo> getTermsInfos() {
return termsInfos;
}
@@ -323,7 +329,9 @@ public class FieldPhraseList {
return sb.toString();
}
- /** @return the seqnum */
+ /**
+ * @return the seqnum
+ */
public int getSeqnum() {
return seqnum;
}
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
index 19a51893d1d..ff5a11c47d6 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
@@ -344,13 +344,17 @@ public class FieldQuery {
return termSetMap.get(fieldMatch ? field : null);
}
- /** @return QueryPhraseMap */
+ /**
+ * @return QueryPhraseMap
+ */
public QueryPhraseMap getFieldTermMap(String fieldName, String term) {
QueryPhraseMap rootMap = getRootMap(fieldName);
return rootMap == null ? null : rootMap.subMap.get(term);
}
- /** @return QueryPhraseMap */
+ /**
+ * @return QueryPhraseMap
+ */
public QueryPhraseMap searchPhrase(String fieldName, final List<TermInfo> phraseCandidate) {
QueryPhraseMap root = getRootMap(fieldName);
if (root == null) return null;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
index d788febfca1..3508710aed3 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
@@ -130,17 +130,23 @@ public class FieldTermStack {
}
}
- /** @return field name */
+ /**
+ * @return field name
+ */
public String getFieldName() {
return fieldName;
}
- /** @return the top TermInfo object of the stack */
+ /**
+ * @return the top TermInfo object of the stack
+ */
public TermInfo pop() {
return termList.poll();
}
- /** @param termInfo the TermInfo object to be put on the top of the stack */
+ /**
+ * @param termInfo the TermInfo object to be put on the top of the stack
+ */
public void push(TermInfo termInfo) {
termList.push(termInfo);
}
diff --git a/lucene/luke/src/java/org/apache/lucene/luke/app/desktop/LukeMain.java b/lucene/luke/src/java/org/apache/lucene/luke/app/desktop/LukeMain.java
index a632eea295c..69dcc888cbc 100644
--- a/lucene/luke/src/java/org/apache/lucene/luke/app/desktop/LukeMain.java
+++ b/lucene/luke/src/java/org/apache/lucene/luke/app/desktop/LukeMain.java
@@ -48,7 +48,9 @@ public class LukeMain {
return frame;
}
- /** @return Returns {@code true} if GUI startup and initialization was successful. */
+ /**
+ * @return Returns {@code true} if GUI startup and initialization was successful.
+ */
private static boolean createGUI() {
// uncaught error handler
MessageBroker messageBroker = MessageBroker.getInstance();
diff --git a/lucene/luke/src/java/org/apache/lucene/luke/util/CircularLogBufferHandler.java b/lucene/luke/src/java/org/apache/lucene/luke/util/CircularLogBufferHandler.java
index 7287cd5a8e0..43a8d754a57 100644
--- a/lucene/luke/src/java/org/apache/lucene/luke/util/CircularLogBufferHandler.java
+++ b/lucene/luke/src/java/org/apache/lucene/luke/util/CircularLogBufferHandler.java
@@ -105,7 +105,9 @@ public class CircularLogBufferHandler extends Handler {
listeners.remove(listener);
}
- /** @return Return a clone of the buffered records so far. */
+ /**
+ * @return Return a clone of the buffered records so far.
+ */
public List<ImmutableLogRecord> getLogRecords() {
synchronized (buffer) {
return List.copyOf(buffer);
diff --git a/lucene/misc/src/java/org/apache/lucene/misc/store/DirectIODirectory.java b/lucene/misc/src/java/org/apache/lucene/misc/store/DirectIODirectory.java
index 01bce7f1319..0cba9c7ef13 100644
--- a/lucene/misc/src/java/org/apache/lucene/misc/store/DirectIODirectory.java
+++ b/lucene/misc/src/java/org/apache/lucene/misc/store/DirectIODirectory.java
@@ -130,7 +130,9 @@ public class DirectIODirectory extends FilterDirectory {
this(delegate, DEFAULT_MERGE_BUFFER_SIZE, DEFAULT_MIN_BYTES_DIRECT);
}
- /** @return the underlying file system directory */
+ /**
+ * @return the underlying file system directory
+ */
public Path getDirectory() {
return ((FSDirectory) in).getDirectory();
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java b/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java
index 711aff372f2..6132e195edb 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java
@@ -99,7 +99,9 @@ public abstract class CandidateMatcher<T extends QueryMatch> {
this.errors.put(queryId, e);
}
- /** @return the matches from this matcher */
+ /**
+ * @return the matches from this matcher
+ */
final MultiMatchingQueries<T> finish(long buildTime, int queryCount) {
doFinish();
this.searchTime =
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/ExplainingMatch.java b/lucene/monitor/src/java/org/apache/lucene/monitor/ExplainingMatch.java
index c36d3d4fb8d..1b4aa4044ef 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/ExplainingMatch.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/ExplainingMatch.java
@@ -60,7 +60,9 @@ public class ExplainingMatch extends QueryMatch {
this.explanation = explanation;
}
- /** @return the Explanation */
+ /**
+ * @return the Explanation
+ */
public Explanation getExplanation() {
return explanation;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/HighlightsMatch.java b/lucene/monitor/src/java/org/apache/lucene/monitor/HighlightsMatch.java
index 50cc859eac6..6092a5992a1 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/HighlightsMatch.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/HighlightsMatch.java
@@ -96,12 +96,16 @@ public class HighlightsMatch extends QueryMatch {
this.hits = new TreeMap<>();
}
- /** @return a map of hits per field */
+ /**
+ * @return a map of hits per field
+ */
public Map<String, Set<Hit>> getHits() {
return Collections.unmodifiableMap(this.hits);
}
- /** @return the fields in which matches have been found */
+ /**
+ * @return the fields in which matches have been found
+ */
public Set<String> getFields() {
return Collections.unmodifiableSet(hits.keySet());
}
@@ -118,7 +122,9 @@ public class HighlightsMatch extends QueryMatch {
return Collections.emptyList();
}
- /** @return the total number of hits for the query */
+ /**
+ * @return the total number of hits for the query
+ */
public int getHitCount() {
int c = 0;
for (Set<Hit> fieldhits : hits.values()) {
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/MatchingQueries.java b/lucene/monitor/src/java/org/apache/lucene/monitor/MatchingQueries.java
index b490bad03cc..3d4bd12ee4e 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/MatchingQueries.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/MatchingQueries.java
@@ -56,32 +56,44 @@ public class MatchingQueries<T extends QueryMatch> {
return matches.get(queryId);
}
- /** @return all matches */
+ /**
+ * @return all matches
+ */
public Collection<T> getMatches() {
return matches.values();
}
- /** @return the number of queries that matched */
+ /**
+ * @return the number of queries that matched
+ */
public int getMatchCount() {
return matches.size();
}
- /** @return how long (in ns) it took to build the Presearcher query for the matcher run */
+ /**
+ * @return how long (in ns) it took to build the Presearcher query for the matcher run
+ */
public long getQueryBuildTime() {
return queryBuildTime;
}
- /** @return how long (in ms) it took to run the selected queries */
+ /**
+ * @return how long (in ms) it took to run the selected queries
+ */
public long getSearchTime() {
return searchTime;
}
- /** @return the number of queries passed to this CandidateMatcher during the matcher run */
+ /**
+ * @return the number of queries passed to this CandidateMatcher during the matcher run
+ */
public int getQueriesRun() {
return queriesRun;
}
- /** @return a List of any MatchErrors created during the matcher run */
+ /**
+ * @return a List of any MatchErrors created during the matcher run
+ */
public Map<String, Exception> getErrors() {
return errors;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/Monitor.java b/lucene/monitor/src/java/org/apache/lucene/monitor/Monitor.java
index 40a4be51b3f..51ddd785606 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/Monitor.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/Monitor.java
@@ -110,7 +110,9 @@ public class Monitor implements Closeable {
queryIndex.addListener(listener);
}
- /** @return Statistics for the internal query index and cache */
+ /**
+ * @return Statistics for the internal query index and cache
+ */
public QueryCacheStats getQueryCacheStats() throws IOException {
return new QueryCacheStats(
queryIndex.numDocs(), queryIndex.cacheSize(), queryIndex.getLastPurged());
@@ -264,7 +266,9 @@ public class Monitor implements Closeable {
return queryIndex.getQuery(queryId);
}
- /** @return the number of queries (after decomposition) stored in this Monitor */
+ /**
+ * @return the number of queries (after decomposition) stored in this Monitor
+ */
public int getDisjunctCount() throws IOException {
return queryIndex.numDocs();
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorConfiguration.java b/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorConfiguration.java
index beff7b4584c..4a6f19da785 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorConfiguration.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorConfiguration.java
@@ -113,7 +113,9 @@ public class MonitorConfiguration {
return this;
}
- /** @return the QueryDecomposer used by the Monitor */
+ /**
+ * @return the QueryDecomposer used by the Monitor
+ */
public QueryDecomposer getQueryDecomposer() {
return queryDecomposer;
}
@@ -131,12 +133,16 @@ public class MonitorConfiguration {
return this;
}
- /** @return the value of Monitor's querycache garbage-collection frequency */
+ /**
+ * @return the value of Monitor's querycache garbage-collection frequency
+ */
public long getPurgeFrequency() {
return purgeFrequency;
}
- /** @return Get the units of the Monitor's querycache garbage-collection frequency */
+ /**
+ * @return Get the units of the Monitor's querycache garbage-collection frequency
+ */
public TimeUnit getPurgeFrequencyUnits() {
return purgeFrequencyUnits;
}
@@ -153,7 +159,9 @@ public class MonitorConfiguration {
return this;
}
- /** @return the size of the queryindex's in-memory buffer */
+ /**
+ * @return the size of the queryindex's in-memory buffer
+ */
public int getQueryUpdateBufferSize() {
return queryUpdateBufferSize;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorQuery.java b/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorQuery.java
index 0f264f925b4..36e4bbaf89e 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorQuery.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/MonitorQuery.java
@@ -66,22 +66,30 @@ public class MonitorQuery {
}
}
- /** @return this MonitorQuery's ID */
+ /**
+ * @return this MonitorQuery's ID
+ */
public String getId() {
return id;
}
- /** @return this MonitorQuery's query */
+ /**
+ * @return this MonitorQuery's query
+ */
public Query getQuery() {
return query;
}
- /** @return this MonitorQuery's string representation */
+ /**
+ * @return this MonitorQuery's string representation
+ */
public String getQueryString() {
return queryString;
}
- /** @return this MonitorQuery's metadata */
+ /**
+ * @return this MonitorQuery's metadata
+ */
public Map<String, String> getMetadata() {
return metadata;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/MultiMatchingQueries.java b/lucene/monitor/src/java/org/apache/lucene/monitor/MultiMatchingQueries.java
index 1777251a3c4..e472f68971a 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/MultiMatchingQueries.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/MultiMatchingQueries.java
@@ -84,27 +84,37 @@ public class MultiMatchingQueries<T extends QueryMatch> {
return docMatches.size();
}
- /** @return how long (in ns) it took to build the Presearcher query for the matcher run */
+ /**
+ * @return how long (in ns) it took to build the Presearcher query for the matcher run
+ */
public long getQueryBuildTime() {
return queryBuildTime;
}
- /** @return how long (in ms) it took to run the selected queries */
+ /**
+ * @return how long (in ms) it took to run the selected queries
+ */
public long getSearchTime() {
return searchTime;
}
- /** @return the number of queries passed to this CandidateMatcher during the matcher run */
+ /**
+ * @return the number of queries passed to this CandidateMatcher during the matcher run
+ */
public int getQueriesRun() {
return queriesRun;
}
- /** @return the number of documents in the batch */
+ /**
+ * @return the number of documents in the batch
+ */
public int getBatchSize() {
return batchSize;
}
- /** @return a List of any MatchErrors created during the matcher run */
+ /**
+ * @return a List of any MatchErrors created during the matcher run
+ */
public Map<String, Exception> getErrors() {
return errors;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/QueryMatch.java b/lucene/monitor/src/java/org/apache/lucene/monitor/QueryMatch.java
index ee4008e65fb..57632094edc 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/QueryMatch.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/QueryMatch.java
@@ -57,7 +57,9 @@ public class QueryMatch {
this.queryId = Objects.requireNonNull(queryId);
}
- /** @return the queryid of this match */
+ /**
+ * @return the queryid of this match
+ */
public String getQueryId() {
return queryId;
}
diff --git a/lucene/monitor/src/java/org/apache/lucene/monitor/TermFilteredPresearcher.java b/lucene/monitor/src/java/org/apache/lucene/monitor/TermFilteredPresearcher.java
index 6ae8b20a4bd..aaf1360fbac 100644
--- a/lucene/monitor/src/java/org/apache/lucene/monitor/TermFilteredPresearcher.java
+++ b/lucene/monitor/src/java/org/apache/lucene/monitor/TermFilteredPresearcher.java
@@ -202,7 +202,9 @@ public class TermFilteredPresearcher extends Presearcher {
/** Add a term from this document */
void addTerm(String field, BytesRef term) throws IOException;
- /** @return the final Query */
+ /**
+ * @return the final Query
+ */
Query build();
}
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionQuery.java
index def1f499bd9..6156d8bb1e0 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionQuery.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionQuery.java
@@ -39,12 +39,16 @@ import org.apache.lucene.search.Weight;
public class FunctionQuery extends Query {
final ValueSource func;
- /** @param func defines the function to be used for scoring */
+ /**
+ * @param func defines the function to be used for scoring
+ */
public FunctionQuery(ValueSource func) {
this.func = func;
}
- /** @return The associated ValueSource */
+ /**
+ * @return The associated ValueSource
+ */
public ValueSource getValueSource() {
return func;
}
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionScoreQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionScoreQuery.java
index 2d207690153..f5f03d20291 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionScoreQuery.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionScoreQuery.java
@@ -57,12 +57,16 @@ public final class FunctionScoreQuery extends Query {
this.source = source;
}
- /** @return the wrapped Query */
+ /**
+ * @return the wrapped Query
+ */
public Query getWrappedQuery() {
return in;
}
- /** @return the underlying value source */
+ /**
+ * @return the underlying value source
+ */
public DoubleValuesSource getSource() {
return source;
}
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionValues.java b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionValues.java
index 5ddd0ed3c1a..0d0a9991900 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionValues.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/function/FunctionValues.java
@@ -103,7 +103,9 @@ public abstract class FunctionValues {
throw new UnsupportedOperationException();
}
- /** @return the number of unique sort ordinals this instance has */
+ /**
+ * @return the number of unique sort ordinals this instance has
+ */
public int numOrd() {
throw new UnsupportedOperationException();
}
@@ -135,7 +137,9 @@ public abstract class FunctionValues {
public abstract void fillValue(int doc) throws IOException;
}
- /** @lucene.experimental */
+ /**
+ * @lucene.experimental
+ */
public ValueFiller getValueFiller() {
return new ValueFiller() {
private final MutableValueFloat mval = new MutableValueFloat();
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/intervals/FilteredIntervalsSource.java b/lucene/queries/src/java/org/apache/lucene/queries/intervals/FilteredIntervalsSource.java
index d97089f393a..4e78b3ffe63 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/intervals/FilteredIntervalsSource.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/intervals/FilteredIntervalsSource.java
@@ -88,7 +88,9 @@ public abstract class FilteredIntervalsSource extends IntervalsSource {
this.in = in;
}
- /** @return {@code false} if the current interval should be filtered out */
+ /**
+ * @return {@code false} if the current interval should be filtered out
+ */
protected abstract boolean accept(IntervalIterator it);
@Override
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalFilter.java b/lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalFilter.java
index 300b6067263..3608071a24c 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalFilter.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalFilter.java
@@ -73,7 +73,9 @@ public abstract class IntervalFilter extends IntervalIterator {
return in.matchCost();
}
- /** @return {@code true} if the wrapped iterator's interval should be passed on */
+ /**
+ * @return {@code true} if the wrapped iterator's interval should be passed on
+ */
protected abstract boolean accept();
@Override
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
index e93a074616c..b94756f8fef 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
@@ -879,7 +879,9 @@ public final class MoreLikeThis {
return createQueue(field2termFreqMap);
}
- /** @see #retrieveInterestingTerms(java.io.Reader, String) */
+ /**
+ * @see #retrieveInterestingTerms(java.io.Reader, String)
+ */
public String[] retrieveInterestingTerms(int docNum) throws IOException {
ArrayList<String> al = new ArrayList<>(maxQueryTerms);
PriorityQueue<ScoreTerm> pq = retrieveTerms(docNum);
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThisQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThisQuery.java
index cd9e7bf1bc3..7ba1bb00b5e 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThisQuery.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThisQuery.java
@@ -45,7 +45,9 @@ public class MoreLikeThisQuery extends Query {
private Set<?> stopWords = null;
private int minDocFreq = -1;
- /** @param moreLikeFields fields used for similarity measure */
+ /**
+ * @param moreLikeFields fields used for similarity measure
+ */
public MoreLikeThisQuery(
String likeText, String[] moreLikeFields, Analyzer analyzer, String fieldName) {
this.likeText = Objects.requireNonNull(likeText);
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionCheckQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionCheckQuery.java
index bf851aa8dfa..0227a13f3ab 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionCheckQuery.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionCheckQuery.java
@@ -38,7 +38,9 @@ public abstract class SpanPositionCheckQuery extends SpanQuery implements Clonea
this.match = Objects.requireNonNull(match);
}
- /** @return the SpanQuery whose matches are filtered. */
+ /**
+ * @return the SpanQuery whose matches are filtered.
+ */
public SpanQuery getMatch() {
return match;
}
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionRangeQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionRangeQuery.java
index 11b0ed34cd5..85740818fee 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionRangeQuery.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/spans/SpanPositionRangeQuery.java
@@ -47,12 +47,16 @@ public class SpanPositionRangeQuery extends SpanPositionCheckQuery {
return res;
}
- /** @return The minimum position permitted in a match */
+ /**
+ * @return The minimum position permitted in a match
+ */
public int getStart() {
return start;
}
- /** @return the maximum end position permitted in a match. */
+ /**
+ * @return the maximum end position permitted in a match.
+ */
public int getEnd() {
return end;
}
diff --git a/lucene/queries/src/test/org/apache/lucene/queries/function/TestValueSources.java b/lucene/queries/src/test/org/apache/lucene/queries/function/TestValueSources.java
index 933c8e7e257..93bed6fe9f5 100644
--- a/lucene/queries/src/test/org/apache/lucene/queries/function/TestValueSources.java
+++ b/lucene/queries/src/test/org/apache/lucene/queries/function/TestValueSources.java
@@ -972,8 +972,12 @@ public class TestValueSources extends LuceneTestCase {
}
}
- /** @see ExistsValueSource */
+ /**
+ * @see ExistsValueSource
+ */
private static final ValueSource ALL_EXIST_VS = new ExistsValueSource(true);
- /** @see ExistsValueSource */
+ /**
+ * @see ExistsValueSource
+ */
private static final ValueSource NONE_EXIST_VS = new ExistsValueSource(false);
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
index 433e8243cc6..e303d1fd993 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
@@ -128,12 +128,16 @@ public abstract class QueryParserBase extends QueryBuilder
}
}
- /** @return Returns the default field. */
+ /**
+ * @return Returns the default field.
+ */
public String getField() {
return field;
}
- /** @see #setAutoGeneratePhraseQueries(boolean) */
+ /**
+ * @see #setAutoGeneratePhraseQueries(boolean)
+ */
public final boolean getAutoGeneratePhraseQueries() {
return autoGeneratePhraseQueries;
}
@@ -209,7 +213,9 @@ public abstract class QueryParserBase extends QueryBuilder
this.allowLeadingWildcard = allowLeadingWildcard;
}
- /** @see #setAllowLeadingWildcard(boolean) */
+ /**
+ * @see #setAllowLeadingWildcard(boolean)
+ */
@Override
public boolean getAllowLeadingWildcard() {
return allowLeadingWildcard;
@@ -245,7 +251,9 @@ public abstract class QueryParserBase extends QueryBuilder
multiTermRewriteMethod = method;
}
- /** @see #setMultiTermRewriteMethod */
+ /**
+ * @see #setMultiTermRewriteMethod
+ */
@Override
public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod() {
return multiTermRewriteMethod;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeError.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeError.java
index 3062b400a79..53c6c4c42c1 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeError.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeError.java
@@ -28,14 +28,18 @@ import org.apache.lucene.queryparser.flexible.messages.NLSException;
public class QueryNodeError extends Error implements NLSException {
private Message message;
- /** @param message - NLS Message Object */
+ /**
+ * @param message - NLS Message Object
+ */
public QueryNodeError(Message message) {
super(message.getKey());
this.message = message;
}
- /** @param throwable - @see java.lang.Error */
+ /**
+ * @param throwable - @see java.lang.Error
+ */
public QueryNodeError(Throwable throwable) {
super(throwable);
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeParseException.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeParseException.java
index 5f373e86797..a713211d1e4 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeParseException.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/QueryNodeParseException.java
@@ -61,7 +61,9 @@ public class QueryNodeParseException extends QueryNodeException {
return this.query;
}
- /** @param errorToken the errorToken in the query */
+ /**
+ * @param errorToken the errorToken in the query
+ */
protected void setErrorToken(String errorToken) {
this.errorToken = errorToken;
}
@@ -96,12 +98,16 @@ public class QueryNodeParseException extends QueryNodeException {
return this.beginColumn;
}
- /** @param beginLine the beginLine to set */
+ /**
+ * @param beginLine the beginLine to set
+ */
protected void setBeginLine(int beginLine) {
this.beginLine = beginLine;
}
- /** @param beginColumn the beginColumn to set */
+ /**
+ * @param beginColumn the beginColumn to set
+ */
protected void setBeginColumn(int beginColumn) {
this.beginColumn = beginColumn;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AndQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AndQueryNode.java
index b7b6c677110..30a2a7c6aeb 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AndQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AndQueryNode.java
@@ -22,7 +22,9 @@ import org.apache.lucene.queryparser.flexible.core.parser.EscapeQuerySyntax;
/** A {@link AndQueryNode} represents an AND boolean operation performed on a list of nodes. */
public class AndQueryNode extends BooleanQueryNode {
- /** @param clauses - the query nodes to be and'ed */
+ /**
+ * @param clauses - the query nodes to be and'ed
+ */
public AndQueryNode(List<QueryNode> clauses) {
super(clauses);
if ((clauses == null) || (clauses.size() == 0)) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AnyQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AnyQueryNode.java
index 843e328bf20..65b6d6f3d4d 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AnyQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/AnyQueryNode.java
@@ -24,7 +24,9 @@ public class AnyQueryNode extends AndQueryNode {
private CharSequence field = null;
private int minimumMatchingmElements = 0;
- /** @param clauses - the query nodes to be or'ed */
+ /**
+ * @param clauses - the query nodes to be or'ed
+ */
public AnyQueryNode(List<QueryNode> clauses, CharSequence field, int minimumMatchingElements) {
super(clauses);
this.field = field;
@@ -71,7 +73,9 @@ public class AnyQueryNode extends AndQueryNode {
else return this.field.toString();
}
- /** @param field - the field to set */
+ /**
+ * @param field - the field to set
+ */
public void setField(CharSequence field) {
this.field = field;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/BooleanQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/BooleanQueryNode.java
index 190646cd684..9f650178f34 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/BooleanQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/BooleanQueryNode.java
@@ -26,7 +26,9 @@ import org.apache.lucene.queryparser.flexible.core.parser.EscapeQuerySyntax;
*/
public class BooleanQueryNode extends QueryNodeImpl {
- /** @param clauses - the query nodes to be and'ed */
+ /**
+ * @param clauses - the query nodes to be and'ed
+ */
public BooleanQueryNode(List<QueryNode> clauses) {
setLeaf(false);
allocate();
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FieldQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FieldQueryNode.java
index 92026d8299c..db9c17eb2a9 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FieldQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FieldQueryNode.java
@@ -82,7 +82,9 @@ public class FieldQueryNode extends QueryNodeImpl
+ "'/>";
}
- /** @return the term */
+ /**
+ * @return the term
+ */
public String getTextAsString() {
if (this.text == null) return null;
else return this.text.toString();
@@ -142,7 +144,9 @@ public class FieldQueryNode extends QueryNodeImpl
return this.text;
}
- /** @param text the text to set */
+ /**
+ * @param text the text to set
+ */
@Override
public void setText(CharSequence text) {
this.text = text;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FuzzyQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FuzzyQueryNode.java
index c69831f9925..72f803c4615 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FuzzyQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/FuzzyQueryNode.java
@@ -84,7 +84,9 @@ public class FuzzyQueryNode extends FieldQueryNode {
return clone;
}
- /** @return the similarity */
+ /**
+ * @return the similarity
+ */
public float getSimilarity() {
return this.similarity;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OpaqueQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OpaqueQueryNode.java
index 0c89b8e282e..52eaad22b15 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OpaqueQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OpaqueQueryNode.java
@@ -60,12 +60,16 @@ public class OpaqueQueryNode extends QueryNodeImpl {
return clone;
}
- /** @return the schema */
+ /**
+ * @return the schema
+ */
public CharSequence getSchema() {
return this.schema;
}
- /** @return the value */
+ /**
+ * @return the value
+ */
public CharSequence getValue() {
return this.value;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OrQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OrQueryNode.java
index 5aada599976..1540c7b7309 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OrQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/OrQueryNode.java
@@ -23,7 +23,9 @@ import org.apache.lucene.queryparser.flexible.core.parser.EscapeQuerySyntax;
/** A {@link OrQueryNode} represents an OR boolean operation performed on a list of nodes. */
public class OrQueryNode extends BooleanQueryNode {
- /** @param clauses - the query nodes to be or'ed */
+ /**
+ * @param clauses - the query nodes to be or'ed
+ */
public OrQueryNode(List<QueryNode> clauses) {
super(clauses);
if ((clauses == null) || (clauses.size() == 0)) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PathQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PathQueryNode.java
index b9429b021ad..a5dac1c6c4e 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PathQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PathQueryNode.java
@@ -69,17 +69,23 @@ public class PathQueryNode extends QueryNodeImpl {
return clone;
}
- /** @return the value */
+ /**
+ * @return the value
+ */
public CharSequence getValue() {
return value;
}
- /** @return the begin */
+ /**
+ * @return the begin
+ */
public int getBegin() {
return begin;
}
- /** @return the end */
+ /**
+ * @return the end
+ */
public int getEnd() {
return end;
}
@@ -92,7 +98,9 @@ public class PathQueryNode extends QueryNodeImpl {
private List<QueryText> values = null;
- /** @param pathElements - List of QueryText objects */
+ /**
+ * @param pathElements - List of QueryText objects
+ */
public PathQueryNode(List<QueryText> pathElements) {
this.values = pathElements;
if (pathElements.size() <= 1) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PhraseSlopQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PhraseSlopQueryNode.java
index 70288effc57..23d772b7b20 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PhraseSlopQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/PhraseSlopQueryNode.java
@@ -27,7 +27,9 @@ public class PhraseSlopQueryNode extends QueryNodeImpl implements FieldableNode
private int value = 0;
- /** @exception QueryNodeError throw in overridden method to disallow */
+ /**
+ * @exception QueryNodeError throw in overridden method to disallow
+ */
public PhraseSlopQueryNode(QueryNode query, int value) {
if (query == null) {
throw new QueryNodeError(
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ProximityQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ProximityQueryNode.java
index a3596c06ff7..5df14d555dd 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ProximityQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ProximityQueryNode.java
@@ -198,7 +198,9 @@ public class ProximityQueryNode extends BooleanQueryNode {
return clone;
}
- /** @return the distance */
+ /**
+ * @return the distance
+ */
public int getDistance() {
return this.distance;
}
@@ -222,12 +224,16 @@ public class ProximityQueryNode extends BooleanQueryNode {
else return this.field.toString();
}
- /** @param field the field to set */
+ /**
+ * @param field the field to set
+ */
public void setField(CharSequence field) {
this.field = field;
}
- /** @return terms must be matched in the specified order */
+ /**
+ * @return terms must be matched in the specified order
+ */
public boolean isInOrder() {
return this.inorder;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessorPipeline.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessorPipeline.java
index 41f8ecf7690..d08db31d438 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessorPipeline.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessorPipeline.java
@@ -94,7 +94,9 @@ public class QueryNodeProcessorPipeline implements QueryNodeProcessor, List<Quer
}
}
- /** @see List#add(Object) */
+ /**
+ * @see List#add(Object)
+ */
@Override
public boolean add(QueryNodeProcessor processor) {
boolean added = this.processors.add(processor);
@@ -106,14 +108,18 @@ public class QueryNodeProcessorPipeline implements QueryNodeProcessor, List<Quer
return added;
}
- /** @see List#add(int, Object) */
+ /**
+ * @see List#add(int, Object)
+ */
@Override
public void add(int index, QueryNodeProcessor processor) {
this.processors.add(index, processor);
processor.setQueryConfigHandler(this.queryConfig);
}
- /** @see List#addAll(Collection) */
+ /**
+ * @see List#addAll(Collection)
+ */
@Override
public boolean addAll(Collection<? extends QueryNodeProcessor> c) {
boolean anyAdded = this.processors.addAll(c);
@@ -125,7 +131,9 @@ public class QueryNodeProcessorPipeline implements QueryNodeProcessor, List<Quer
return anyAdded;
}
- /** @see List#addAll(int, Collection) */
+ /**
+ * @see List#addAll(int, Collection)
+ */
@Override
public boolean addAll(int index, Collection<? extends QueryNodeProcessor> c) {
boolean anyAdded = this.processors.addAll(index, c);
@@ -137,91 +145,121 @@ public class QueryNodeProcessorPipeline implements QueryNodeProcessor, List<Quer
return anyAdded;
}
- /** @see List#clear() */
+ /**
+ * @see List#clear()
+ */
@Override
public void clear() {
this.processors.clear();
}
- /** @see List#contains(Object) */
+ /**
+ * @see List#contains(Object)
+ */
@Override
public boolean contains(Object o) {
return this.processors.contains(o);
}
- /** @see List#containsAll(Collection) */
+ /**
+ * @see List#containsAll(Collection)
+ */
@Override
public boolean containsAll(Collection<?> c) {
return this.processors.containsAll(c);
}
- /** @see List#get(int) */
+ /**
+ * @see List#get(int)
+ */
@Override
public QueryNodeProcessor get(int index) {
return this.processors.get(index);
}
- /** @see List#indexOf(Object) */
+ /**
+ * @see List#indexOf(Object)
+ */
@Override
public int indexOf(Object o) {
return this.processors.indexOf(o);
}
- /** @see List#isEmpty() */
+ /**
+ * @see List#isEmpty()
+ */
@Override
public boolean isEmpty() {
return this.processors.isEmpty();
}
- /** @see List#iterator() */
+ /**
+ * @see List#iterator()
+ */
@Override
public Iterator<QueryNodeProcessor> iterator() {
return this.processors.iterator();
}
- /** @see List#lastIndexOf(Object) */
+ /**
+ * @see List#lastIndexOf(Object)
+ */
@Override
public int lastIndexOf(Object o) {
return this.processors.lastIndexOf(o);
}
- /** @see List#listIterator() */
+ /**
+ * @see List#listIterator()
+ */
@Override
public ListIterator<QueryNodeProcessor> listIterator() {
return this.processors.listIterator();
}
- /** @see List#listIterator(int) */
+ /**
+ * @see List#listIterator(int)
+ */
@Override
public ListIterator<QueryNodeProcessor> listIterator(int index) {
return this.processors.listIterator(index);
}
- /** @see List#remove(Object) */
+ /**
+ * @see List#remove(Object)
+ */
@Override
public boolean remove(Object o) {
return this.processors.remove(o);
}
- /** @see List#remove(int) */
+ /**
+ * @see List#remove(int)
+ */
@Override
public QueryNodeProcessor remove(int index) {
return this.processors.remove(index);
}
- /** @see List#removeAll(Collection) */
+ /**
+ * @see List#removeAll(Collection)
+ */
@Override
public boolean removeAll(Collection<?> c) {
return this.processors.removeAll(c);
}
- /** @see List#retainAll(Collection) */
+ /**
+ * @see List#retainAll(Collection)
+ */
@Override
public boolean retainAll(Collection<?> c) {
return this.processors.retainAll(c);
}
- /** @see List#set(int, Object) */
+ /**
+ * @see List#set(int, Object)
+ */
@Override
public QueryNodeProcessor set(int index, QueryNodeProcessor processor) {
QueryNodeProcessor oldProcessor = this.processors.set(index, processor);
@@ -233,25 +271,33 @@ public class QueryNodeProcessorPipeline implements QueryNodeProcessor, List<Quer
return oldProcessor;
}
- /** @see List#size() */
+ /**
+ * @see List#size()
+ */
@Override
public int size() {
return this.processors.size();
}
- /** @see List#subList(int, int) */
+ /**
+ * @see List#subList(int, int)
+ */
@Override
public List<QueryNodeProcessor> subList(int fromIndex, int toIndex) {
return this.processors.subList(fromIndex, toIndex);
}
- /** @see List#toArray(Object[]) */
+ /**
+ * @see List#toArray(Object[])
+ */
@Override
public <T> T[] toArray(T[] array) {
return this.processors.toArray(array);
}
- /** @see List#toArray() */
+ /**
+ * @see List#toArray()
+ */
@Override
public Object[] toArray() {
return this.processors.toArray();
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
index 12a75bcd7c6..67d030b3579 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
@@ -140,7 +140,9 @@ public class NLS {
}
}
- /** @param key - Message Key */
+ /**
+ * @param key - Message Key
+ */
private static void validateMessage(String key, Class<? extends NLS> clazz) {
// Test if the message is present in the resource bundle
try {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLSException.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLSException.java
index ce52d86d632..1f345cfb99d 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLSException.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLSException.java
@@ -24,6 +24,8 @@ package org.apache.lucene.queryparser.flexible.messages;
* <p>This Interface should be implemented by all exceptions that require translation
*/
public interface NLSException {
- /** @return a instance of a class that implements the Message interface */
+ /**
+ * @return a instance of a class that implements the Message interface
+ */
public Message getMessageObject();
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/precedence/PrecedenceQueryParser.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/precedence/PrecedenceQueryParser.java
index 9efa6bf1e6f..6ce5282e8b9 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/precedence/PrecedenceQueryParser.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/precedence/PrecedenceQueryParser.java
@@ -34,12 +34,16 @@ import org.apache.lucene.queryparser.flexible.standard.processors.StandardQueryN
*/
public class PrecedenceQueryParser extends StandardQueryParser {
- /** @see StandardQueryParser#StandardQueryParser() */
+ /**
+ * @see StandardQueryParser#StandardQueryParser()
+ */
public PrecedenceQueryParser() {
setQueryNodeProcessor(new PrecedenceQueryNodeProcessorPipeline(getQueryConfigHandler()));
}
- /** @see StandardQueryParser#StandardQueryParser(Analyzer) */
+ /**
+ * @see StandardQueryParser#StandardQueryParser(Analyzer)
+ */
public PrecedenceQueryParser(Analyzer analyer) {
super(analyer);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/CommonQueryParserConfiguration.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/CommonQueryParserConfiguration.java
index 2aecec32897..2f9a1725d3e 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/CommonQueryParserConfiguration.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/CommonQueryParserConfiguration.java
@@ -49,7 +49,9 @@ public interface CommonQueryParserConfiguration {
*/
public void setEnablePositionIncrements(boolean enabled);
- /** @see #setEnablePositionIncrements(boolean) */
+ /**
+ * @see #setEnablePositionIncrements(boolean)
+ */
public boolean getEnablePositionIncrements();
/**
@@ -62,7 +64,9 @@ public interface CommonQueryParserConfiguration {
*/
public void setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method);
- /** @see #setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod) */
+ /**
+ * @see #setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod)
+ */
public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod();
/**
@@ -90,7 +94,9 @@ public interface CommonQueryParserConfiguration {
public Analyzer getAnalyzer();
- /** @see #setAllowLeadingWildcard(boolean) */
+ /**
+ * @see #setAllowLeadingWildcard(boolean)
+ */
public boolean getAllowLeadingWildcard();
/** Get the minimal similarity for fuzzy queries. */
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/StandardQueryParser.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/StandardQueryParser.java
index e0881b30120..9b24643067b 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/StandardQueryParser.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/StandardQueryParser.java
@@ -326,7 +326,9 @@ public class StandardQueryParser extends QueryParserHelper
getQueryConfigHandler().set(ConfigurationKeys.ENABLE_POSITION_INCREMENTS, enabled);
}
- /** @see #setEnablePositionIncrements(boolean) */
+ /**
+ * @see #setEnablePositionIncrements(boolean)
+ */
@Override
public boolean getEnablePositionIncrements() {
Boolean enablePositionsIncrements =
@@ -353,7 +355,9 @@ public class StandardQueryParser extends QueryParserHelper
getQueryConfigHandler().set(ConfigurationKeys.MULTI_TERM_REWRITE_METHOD, method);
}
- /** @see #setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod) */
+ /**
+ * @see #setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod)
+ */
@Override
public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod() {
return getQueryConfigHandler().get(ConfigurationKeys.MULTI_TERM_REWRITE_METHOD);
@@ -449,7 +453,9 @@ public class StandardQueryParser extends QueryParserHelper
return getQueryConfigHandler().get(ConfigurationKeys.ANALYZER);
}
- /** @see #setAllowLeadingWildcard(boolean) */
+ /**
+ * @see #setAllowLeadingWildcard(boolean)
+ */
@Override
public boolean getAllowLeadingWildcard() {
Boolean allowLeadingWildcard =
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
index 14eff99d5a6..6222e11c9fc 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
@@ -68,7 +68,9 @@ public class IndexAndTaxonomyRevision implements Revision {
super(directory, openMode);
}
- /** @see DirectoryTaxonomyWriter#DirectoryTaxonomyWriter(Directory) */
+ /**
+ * @see DirectoryTaxonomyWriter#DirectoryTaxonomyWriter(Directory)
+ */
public SnapshotDirectoryTaxonomyWriter(Directory d) throws IOException {
super(d);
}
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
index ab156bf453b..81fa3dbc986 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
@@ -27,17 +27,23 @@ import java.io.IOException;
*/
public class SessionExpiredException extends IOException {
- /** @see IOException#IOException(String, Throwable) */
+ /**
+ * @see IOException#IOException(String, Throwable)
+ */
public SessionExpiredException(String message, Throwable cause) {
super(message, cause);
}
- /** @see IOException#IOException(String) */
+ /**
+ * @see IOException#IOException(String)
+ */
public SessionExpiredException(String message) {
super(message);
}
- /** @see IOException#IOException(Throwable) */
+ /**
+ * @see IOException#IOException(Throwable)
+ */
public SessionExpiredException(Throwable cause) {
super(cause);
}
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
index ef7ee223c4a..d359ea140d9 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
@@ -44,10 +44,14 @@ public final class SessionToken {
*/
public final String id;
- /** @see Revision#getVersion() */
+ /**
+ * @see Revision#getVersion()
+ */
public final String version;
- /** @see Revision#getSourceFiles() */
+ /**
+ * @see Revision#getSourceFiles()
+ */
public final Map<String, List<RevisionFile>> sourceFiles;
/** Constructor which deserializes from the given {@link DataInput}. */
diff --git a/lucene/sandbox/src/java/org/apache/lucene/payloads/PayloadSpanCollector.java b/lucene/sandbox/src/java/org/apache/lucene/payloads/PayloadSpanCollector.java
index abd9480012e..cb06e67e3fb 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/payloads/PayloadSpanCollector.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/payloads/PayloadSpanCollector.java
@@ -45,7 +45,9 @@ public class PayloadSpanCollector implements SpanCollector {
payloads.clear();
}
- /** @return the collected payloads */
+ /**
+ * @return the collected payloads
+ */
public Collection<byte[]> getPayloads() {
return payloads;
}
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/DocValuesTermsQuery.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/DocValuesTermsQuery.java
index b95a7b2114c..dc4d922fb2b 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/DocValuesTermsQuery.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/DocValuesTermsQuery.java
@@ -157,12 +157,16 @@ public class DocValuesTermsQuery extends Query implements Accountable {
return builder.toString();
}
- /** @return the name of the field searched by this query. */
+ /**
+ * @return the name of the field searched by this query.
+ */
public String getField() {
return field;
}
- /** @return the terms looked up by this query, prefix-encoded. */
+ /**
+ * @return the terms looked up by this query, prefix-encoded.
+ */
public PrefixCodedTerms getTerms() {
return termData;
}
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollector.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollector.java
index 94f56b93189..2040e37f795 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollector.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollector.java
@@ -53,17 +53,23 @@ public class ProfilerCollector implements Collector {
this.children = children;
}
- /** @return the profiled time for this collector (inclusive of children) */
+ /**
+ * @return the profiled time for this collector (inclusive of children)
+ */
public long getTime() {
return collector.getTime();
}
- /** @return a human readable "hint" about what this collector was used for */
+ /**
+ * @return a human readable "hint" about what this collector was used for
+ */
public String getReason() {
return this.reason;
}
- /** @return the lucene class name of the collector */
+ /**
+ * @return the lucene class name of the collector
+ */
public String getName() {
return this.collectorName;
}
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollectorResult.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollectorResult.java
index 0f6ec57567c..8b43b648365 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollectorResult.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/ProfilerCollectorResult.java
@@ -45,22 +45,30 @@ public class ProfilerCollectorResult {
this.children = children;
}
- /** @return the profiled time for this collector (inclusive of children) */
+ /**
+ * @return the profiled time for this collector (inclusive of children)
+ */
public long getTime() {
return this.time;
}
- /** @return a human readable "hint" about what this collector was used for */
+ /**
+ * @return a human readable "hint" about what this collector was used for
+ */
public String getReason() {
return this.reason;
}
- /** @return the lucene class name of the collector */
+ /**
+ * @return the lucene class name of the collector
+ */
public String getName() {
return this.collectorName;
}
- /** @return a list of children collectors */
+ /**
+ * @return a list of children collectors
+ */
public List<ProfilerCollectorResult> getProfiledChildren() {
return children;
}
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/QueryProfilerIndexSearcher.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/QueryProfilerIndexSearcher.java
index 71cc2f4cea0..37c4698b542 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/QueryProfilerIndexSearcher.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/QueryProfilerIndexSearcher.java
@@ -66,12 +66,16 @@ public class QueryProfilerIndexSearcher extends IndexSearcher {
return new QueryProfilerWeight(query, weight, profile);
}
- /** @return total time taken to rewrite all queries in this profile */
+ /**
+ * @return total time taken to rewrite all queries in this profile
+ */
public long getRewriteTime() {
return profiler.getRewriteTime();
}
- /** @return a hierarchical representation of the profiled tree */
+ /**
+ * @return a hierarchical representation of the profiled tree
+ */
public List<QueryProfilerResult> getProfileResult() {
return profiler.getTree();
}
diff --git a/lucene/spatial-extras/src/java/org/apache/lucene/spatial/vector/PointVectorStrategy.java b/lucene/spatial-extras/src/java/org/apache/lucene/spatial/vector/PointVectorStrategy.java
index 376b39ecddf..77055d15ae2 100644
--- a/lucene/spatial-extras/src/java/org/apache/lucene/spatial/vector/PointVectorStrategy.java
+++ b/lucene/spatial-extras/src/java/org/apache/lucene/spatial/vector/PointVectorStrategy.java
@@ -154,7 +154,9 @@ public class PointVectorStrategy extends SpatialStrategy {
throw new UnsupportedOperationException("Can only index Point, not " + shape);
}
- /** @see #createIndexableFields(org.locationtech.spatial4j.shape.Shape) */
+ /**
+ * @see #createIndexableFields(org.locationtech.spatial4j.shape.Shape)
+ */
public Field[] createIndexableFields(Point point) {
Field[] fields = new Field[fieldsLen];
int idx = -1;
diff --git a/lucene/spatial-test-fixtures/src/java/org/apache/lucene/spatial3d/tests/RandomGeo3dShapeGenerator.java b/lucene/spatial-test-fixtures/src/java/org/apache/lucene/spatial3d/tests/RandomGeo3dShapeGenerator.java
index d3ddb3f7855..921d09b94a5 100644
--- a/lucene/spatial-test-fixtures/src/java/org/apache/lucene/spatial3d/tests/RandomGeo3dShapeGenerator.java
+++ b/lucene/spatial-test-fixtures/src/java/org/apache/lucene/spatial3d/tests/RandomGeo3dShapeGenerator.java
@@ -79,7 +79,9 @@ public final class RandomGeo3dShapeGenerator {
/** Static methods only. */
private RandomGeo3dShapeGenerator() {}
- /** @return Returns a private-use random forked from the current {@link RandomizedContext}. */
+ /**
+ * @return Returns a private-use random forked from the current {@link RandomizedContext}.
+ */
private static Random random() {
return new Random(RandomizedContext.current().getRandom().nextLong());
}
diff --git a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoComplexPolygon.java b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoComplexPolygon.java
index 0155916dded..88db001880a 100644
--- a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoComplexPolygon.java
+++ b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoComplexPolygon.java
@@ -1134,10 +1134,14 @@ class GeoComplexPolygon extends GeoBasePolygon {
* will cause this object to be called.
*/
private static interface CountingEdgeIterator extends EdgeIterator {
- /** @return the number of edges that were crossed. */
+ /**
+ * @return the number of edges that were crossed.
+ */
public int getCrossingCount();
- /** @return true if the endpoint was on an edge. */
+ /**
+ * @return true if the endpoint was on an edge.
+ */
public boolean isOnEdge();
}
diff --git a/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java b/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java
index 12fd572846b..8bccc344b50 100644
--- a/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java
+++ b/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java
@@ -89,10 +89,14 @@ public class FSTCompletion {
*/
private final Arc<Object>[] rootArcs;
- /** @see #FSTCompletion(FST, boolean, boolean) */
+ /**
+ * @see #FSTCompletion(FST, boolean, boolean)
+ */
private boolean exactFirst;
- /** @see #FSTCompletion(FST, boolean, boolean) */
+ /**
+ * @see #FSTCompletion(FST, boolean, boolean)
+ */
private boolean higherWeightsFirst;
/**
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/mockfile/ExtrasFS.java b/lucene/test-framework/src/java/org/apache/lucene/tests/mockfile/ExtrasFS.java
index 124731b801b..ca972581cc4 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/mockfile/ExtrasFS.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/mockfile/ExtrasFS.java
@@ -78,7 +78,9 @@ public class ExtrasFS extends FilterFileSystemProvider {
// our fake files. But this is tricky because its hooked into several places.
// Currently MDW has a hack so we don't break disk full tests.
- /** @return Return true if {@code fileName} is one of the extra files added by this class. */
+ /**
+ * @return Return true if {@code fileName} is one of the extra files added by this class.
+ */
public static boolean isExtra(String fileName) {
return fileName.equals(EXTRA_FILE_NAME);
}
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/search/MatchesTestBase.java b/lucene/test-framework/src/java/org/apache/lucene/tests/search/MatchesTestBase.java
index ad42ec73a39..5d881ffdd9b 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/search/MatchesTestBase.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/search/MatchesTestBase.java
@@ -51,7 +51,9 @@ import org.apache.lucene.tests.util.LuceneTestCase;
*/
public abstract class MatchesTestBase extends LuceneTestCase {
- /** @return an array of documents to be indexed */
+ /**
+ * @return an array of documents to be indexed
+ */
protected abstract String[] getDocuments();
protected IndexSearcher searcher;
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/util/LuceneTestCase.java b/lucene/test-framework/src/java/org/apache/lucene/tests/util/LuceneTestCase.java
index 9da1775ee8a..11d7d52a59f 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/util/LuceneTestCase.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/util/LuceneTestCase.java
@@ -275,10 +275,14 @@ public abstract class LuceneTestCase extends Assert {
public static final String SYSPROP_MONSTER = "tests.monster";
public static final String SYSPROP_AWAITSFIX = "tests.awaitsfix";
- /** @see #ignoreAfterMaxFailures */
+ /**
+ * @see #ignoreAfterMaxFailures
+ */
public static final String SYSPROP_MAXFAILURES = "tests.maxfailures";
- /** @see #ignoreAfterMaxFailures */
+ /**
+ * @see #ignoreAfterMaxFailures
+ */
public static final String SYSPROP_FAILFAST = "tests.failfast";
/** Annotation for tests that should only be run during nightly builds. */
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupAndRestoreClassEnv.java b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupAndRestoreClassEnv.java
index a041d1951e1..f467d4a2cae 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupAndRestoreClassEnv.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupAndRestoreClassEnv.java
@@ -71,7 +71,9 @@ final class TestRuleSetupAndRestoreClassEnv extends AbstractBeforeAfterRule {
/** Indicates whether the rule has executed its {@link #before()} method fully. */
private boolean initialized;
- /** @see SuppressCodecs */
+ /**
+ * @see SuppressCodecs
+ */
HashSet<String> avoidCodecs;
static class ThreadNameFixingPrintStreamInfoStream extends PrintStreamInfoStream {
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupTeardownChained.java b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupTeardownChained.java
index ec8110bd5b2..19d1e21b517 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupTeardownChained.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleSetupTeardownChained.java
@@ -28,10 +28,14 @@ import org.junit.runners.model.Statement;
* checked upon successful execution of each test case.
*/
class TestRuleSetupTeardownChained implements TestRule {
- /** @see TestRuleSetupTeardownChained */
+ /**
+ * @see TestRuleSetupTeardownChained
+ */
public boolean setupCalled;
- /** @see TestRuleSetupTeardownChained */
+ /**
+ * @see TestRuleSetupTeardownChained
+ */
public boolean teardownCalled;
@Override
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleTemporaryFilesCleanup.java b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleTemporaryFilesCleanup.java
index 8d000f509e9..e3ff2f798d6 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleTemporaryFilesCleanup.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/util/TestRuleTemporaryFilesCleanup.java
@@ -268,7 +268,9 @@ final class TestRuleTemporaryFilesCleanup extends TestRuleAdapter {
return tempDirBase;
}
- /** @see LuceneTestCase#createTempDir() */
+ /**
+ * @see LuceneTestCase#createTempDir()
+ */
public Path createTempDir(String prefix) {
Path base = getPerTestClassTempDir();
@@ -295,7 +297,9 @@ final class TestRuleTemporaryFilesCleanup extends TestRuleAdapter {
return f;
}
- /** @see LuceneTestCase#createTempFile() */
+ /**
+ * @see LuceneTestCase#createTempFile()
+ */
public Path createTempFile(String prefix, String suffix) throws IOException {
Path base = getPerTestClassTempDir();
diff --git a/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestMaxFailuresRule.java b/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestMaxFailuresRule.java
index 2556648e5a9..12a044eec94 100644
--- a/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestMaxFailuresRule.java
+++ b/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestMaxFailuresRule.java
@@ -33,7 +33,9 @@ import org.junit.runner.Result;
import org.junit.runner.notification.Failure;
import org.junit.runner.notification.RunListener;
-/** @see TestRuleIgnoreAfterMaxFailures */
+/**
+ * @see TestRuleIgnoreAfterMaxFailures
+ */
public class TestMaxFailuresRule extends WithNestedTests {
public TestMaxFailuresRule() {
super(true);
diff --git a/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestSysoutsLimits.java b/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestSysoutsLimits.java
index eb23321be05..7d4e28a02d9 100644
--- a/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestSysoutsLimits.java
+++ b/lucene/test-framework/src/test/org/apache/lucene/tests/util/TestSysoutsLimits.java
@@ -24,7 +24,9 @@ import org.junit.Test;
import org.junit.runner.JUnitCore;
import org.junit.runner.Result;
-/** @see TestRuleLimitSysouts */
+/**
+ * @see TestRuleLimitSysouts
+ */
public class TestSysoutsLimits extends WithNestedTests {
public TestSysoutsLimits() {
super(false);