You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by us...@apache.org on 2012/08/15 10:01:50 UTC
svn commit: r1373246 - in
/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index:
AtomicReaderContext.java CompositeReader.java CompositeReaderContext.java
IndexReader.java IndexReaderContext.java
Author: uschindler
Date: Wed Aug 15 08:01:50 2012
New Revision: 1373246
URL: http://svn.apache.org/viewvc?rev=1373246&view=rev
Log:
Improve Javadocs, fix wrong getContext() javadocs (contained outdated info, leaves() throws UOE if not top-level), remove lucene.experimental from contexts, as this is now the official API to walk reader tree.
Modified:
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/AtomicReaderContext.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReader.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReaderContext.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReader.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReaderContext.java
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/AtomicReaderContext.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/AtomicReaderContext.java?rev=1373246&r1=1373245&r2=1373246&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/AtomicReaderContext.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/AtomicReaderContext.java Wed Aug 15 08:01:50 2012
@@ -21,8 +21,7 @@ import java.util.Collections;
import java.util.List;
/**
- * {@link IndexReaderContext} for {@link AtomicReader} instances
- * @lucene.experimental
+ * {@link IndexReaderContext} for {@link AtomicReader} instances.
*/
public final class AtomicReaderContext extends IndexReaderContext {
/** The readers ord in the top-level's leaves array */
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReader.java?rev=1373246&r1=1373245&r2=1373246&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReader.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReader.java Wed Aug 15 08:01:50 2012
@@ -81,11 +81,10 @@ public abstract class CompositeReader ex
* reader is logically composed of. This method may not
* return {@code null}.
*
- * <p>In contrast to previous Lucene versions this method is no
- * longer public, code that wants to get all {@link AtomicReader}s
+ * <p><b>NOTE:</b> In contrast to previous Lucene versions this method
+ * is no longer public, code that wants to get all {@link AtomicReader}s
* this composite is composed of should use {@link IndexReader#leaves()}.
- *
- * @lucene.internal
+ * @see IndexReader#leaves()
*/
protected abstract List<? extends IndexReader> getSequentialSubReaders();
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReaderContext.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReaderContext.java?rev=1373246&r1=1373245&r2=1373246&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReaderContext.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CompositeReaderContext.java Wed Aug 15 08:01:50 2012
@@ -24,7 +24,6 @@ import java.util.List;
/**
* {@link IndexReaderContext} for {@link CompositeReader} instance.
- * @lucene.experimental
*/
public final class CompositeReaderContext extends IndexReaderContext {
private final List<IndexReaderContext> children;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReader.java?rev=1373246&r1=1373245&r2=1373246&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReader.java Wed Aug 15 08:01:50 2012
@@ -391,17 +391,17 @@ public abstract class IndexReader implem
* atomic leaf reader at a time. If this reader is not composed of child
* readers, this method returns an {@link AtomicReaderContext}.
* <p>
- * Note: Any of the sub-{@link CompositeReaderContext} instances reference from this
- * top-level context holds a <code>null</code> {@link CompositeReaderContext#leaves()}
- * reference. Only the top-level context maintains the convenience leaf-view
+ * Note: Any of the sub-{@link CompositeReaderContext} instances referenced
+ * from this top-level context do not support {@link CompositeReaderContext#leaves()}.
+ * Only the top-level context maintains the convenience leaf-view
* for performance reasons.
- *
- * @lucene.experimental
*/
public abstract IndexReaderContext getContext();
/**
- * Returns the reader's leaves, or itself if this reader is Atomic.
+ * Returns the reader's leaves, or itself if this reader is atomic.
+ * This is a convenience method calling {@code this.getContext().leaves()}.
+ * @see IndexReaderContext#leaves()
*/
public final List<AtomicReaderContext> leaves() {
return getContext().leaves();
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReaderContext.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReaderContext.java?rev=1373246&r1=1373245&r2=1373246&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReaderContext.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexReaderContext.java Wed Aug 15 08:01:50 2012
@@ -22,7 +22,6 @@ import java.util.List;
/**
* A struct like class that represents a hierarchical relationship between
* {@link IndexReader} instances.
- * @lucene.experimental
*/
public abstract class IndexReaderContext {
/** The reader context for this reader's immediate parent, or null if none */