You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2020/09/02 12:03:26 UTC
[lucene-solr] branch LUCENE-9215 updated: LUCENE-9215: add missing
javadocs and reset visibility
This is an automated email from the ASF dual-hosted git repository.
rmuir pushed a commit to branch LUCENE-9215
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
The following commit(s) were added to refs/heads/LUCENE-9215 by this push:
new ba4fbcd LUCENE-9215: add missing javadocs and reset visibility
ba4fbcd is described below
commit ba4fbcdac1d551fd8b09d11d6e91d1cd145c0caa
Author: Robert Muir <rm...@apache.org>
AuthorDate: Wed Sep 2 08:04:48 2020 -0400
LUCENE-9215: add missing javadocs and reset visibility
---
.../org/apache/lucene/search/spans/SpanContainingQuery.java | 8 ++++++--
.../java/org/apache/lucene/search/spans/SpanNearQuery.java | 6 +++++-
.../java/org/apache/lucene/search/spans/SpanNotQuery.java | 6 +++++-
.../src/java/org/apache/lucene/search/spans/SpanOrQuery.java | 6 +++++-
.../apache/lucene/search/spans/SpanPositionCheckQuery.java | 6 +++++-
.../java/org/apache/lucene/search/spans/SpanTermQuery.java | 6 +++++-
.../java/org/apache/lucene/search/spans/SpanWithinQuery.java | 8 ++++++--
lucene/core/src/java/org/apache/lucene/util/PagedBytes.java | 12 ++++++++++--
.../org/apache/lucene/queries/function/FunctionQuery.java | 12 ++++++++++--
9 files changed, 57 insertions(+), 13 deletions(-)
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanContainingQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanContainingQuery.java
index 9bfca32..f3909bb 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanContainingQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanContainingQuery.java
@@ -51,7 +51,11 @@ public final class SpanContainingQuery extends SpanContainQuery {
bigWeight, littleWeight, boost);
}
- private class SpanContainingWeight extends SpanContainWeight {
+ /**
+ * Creates SpanContainingQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanContainingWeight extends SpanContainWeight {
public SpanContainingWeight(IndexSearcher searcher, Map<Term, TermStates> terms,
SpanWeight bigWeight, SpanWeight littleWeight, float boost) throws IOException {
@@ -123,4 +127,4 @@ public final class SpanContainingQuery extends SpanContainQuery {
}
}
-}
\ No newline at end of file
+}
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanNearQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanNearQuery.java
index 3b628d1..900f7b6 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanNearQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanNearQuery.java
@@ -187,7 +187,11 @@ public class SpanNearQuery extends SpanQuery implements Cloneable {
return new SpanNearWeight(subWeights, searcher, scoreMode.needsScores() ? getTermStates(subWeights) : null, boost);
}
- private class SpanNearWeight extends SpanWeight {
+ /**
+ * Creates SpanNearQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanNearWeight extends SpanWeight {
final List<SpanWeight> subWeights;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanNotQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanNotQuery.java
index 8c6112a..bad825f 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanNotQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanNotQuery.java
@@ -106,7 +106,11 @@ public final class SpanNotQuery extends SpanQuery {
includeWeight, excludeWeight, boost);
}
- private class SpanNotWeight extends SpanWeight {
+ /**
+ * Creates SpanNotQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanNotWeight extends SpanWeight {
final SpanWeight includeWeight;
final SpanWeight excludeWeight;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanOrQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanOrQuery.java
index 07e612e..0a8e89e 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanOrQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanOrQuery.java
@@ -136,7 +136,11 @@ public final class SpanOrQuery extends SpanQuery {
return new SpanOrWeight(searcher, scoreMode.needsScores() ? getTermStates(subWeights) : null, subWeights, boost);
}
- private class SpanOrWeight extends SpanWeight {
+ /**
+ * Creates SpanOrQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanOrWeight extends SpanWeight {
final List<SpanWeight> subWeights;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java
index 3dc9a3c..e2d09c2 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java
@@ -74,7 +74,11 @@ public abstract class SpanPositionCheckQuery extends SpanQuery implements Clonea
return new SpanPositionCheckWeight(matchWeight, searcher, scoreMode.needsScores() ? getTermStates(matchWeight) : null, boost);
}
- private class SpanPositionCheckWeight extends SpanWeight {
+ /**
+ * Creates SpanPositionCheckQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanPositionCheckWeight extends SpanWeight {
final SpanWeight matchWeight;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanTermQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanTermQuery.java
index 08310b7..dda3f44 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanTermQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanTermQuery.java
@@ -91,7 +91,11 @@ public class SpanTermQuery extends SpanQuery {
}
}
- private class SpanTermWeight extends SpanWeight {
+ /**
+ * Creates SpanTermQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanTermWeight extends SpanWeight {
final TermStates termStates;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/SpanWithinQuery.java b/lucene/core/src/java/org/apache/lucene/search/spans/SpanWithinQuery.java
index 6827886..dfe8c83 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/SpanWithinQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/SpanWithinQuery.java
@@ -52,7 +52,11 @@ public final class SpanWithinQuery extends SpanContainQuery {
bigWeight, littleWeight, boost);
}
- private class SpanWithinWeight extends SpanContainWeight {
+ /**
+ * Creates SpanWithinQuery scorer instances
+ * @lucene.internal
+ */
+ public class SpanWithinWeight extends SpanContainWeight {
public SpanWithinWeight(IndexSearcher searcher, Map<Term, TermStates> terms,
SpanWeight bigWeight, SpanWeight littleWeight, float boost) throws IOException {
@@ -125,4 +129,4 @@ public final class SpanWithinQuery extends SpanContainQuery {
}
-}
\ No newline at end of file
+}
diff --git a/lucene/core/src/java/org/apache/lucene/util/PagedBytes.java b/lucene/core/src/java/org/apache/lucene/util/PagedBytes.java
index a1acab5..6127864 100644
--- a/lucene/core/src/java/org/apache/lucene/util/PagedBytes.java
+++ b/lucene/core/src/java/org/apache/lucene/util/PagedBytes.java
@@ -282,7 +282,11 @@ public final class PagedBytes implements Accountable {
return pointer;
}
- private final class PagedBytesDataInput extends DataInput {
+ /**
+ * Input that transparently iterates over pages
+ * @lucene.internal
+ */
+ public final class PagedBytesDataInput extends DataInput {
private int currentBlockIndex;
private int currentBlockUpto;
private byte[] currentBlock;
@@ -350,7 +354,11 @@ public final class PagedBytes implements Accountable {
}
}
- private final class PagedBytesDataOutput extends DataOutput {
+ /**
+ * Output that transparently spills to new pages as necessary
+ * @lucene.internal
+ */
+ public final class PagedBytesDataOutput extends DataOutput {
@Override
public void writeByte(byte b) {
if (upto == blockSize) {
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 480e549..92e50df 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
@@ -53,7 +53,11 @@ public class FunctionQuery extends Query {
return func;
}
- private class FunctionWeight extends Weight {
+ /**
+ * Creates FunctionQuery scorer instances
+ * @lucene.internal
+ */
+ protected class FunctionWeight extends Weight {
protected final IndexSearcher searcher;
protected final float boost;
protected final Map<Object, Object> context;
@@ -87,7 +91,11 @@ public class FunctionQuery extends Query {
visitor.visitLeaf(this);
}
- private class AllScorer extends Scorer {
+ /**
+ * Scores all documents, applying the function to each document
+ * @lucene.internal
+ */
+ protected class AllScorer extends Scorer {
final IndexReader reader;
final FunctionWeight weight;
final int maxDoc;