You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2012/08/16 21:20:14 UTC
svn commit: r1373992 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/core/ lucene/core/src/java/org/apache/lucene/codecs/sep/
Author: mikemccand
Date: Thu Aug 16 19:20:13 2012
New Revision: 1373992
URL: http://svn.apache.org/viewvc?rev=1373992&view=rev
Log:
improve javadocs
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/lucene/ (props changed)
lucene/dev/branches/branch_4x/lucene/core/ (props changed)
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexInput.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexOutput.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntStreamFactory.java
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexInput.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexInput.java?rev=1373992&r1=1373991&r2=1373992&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexInput.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexInput.java Thu Aug 16 19:20:13 2012
@@ -36,7 +36,7 @@ public abstract class IntIndexInput impl
public abstract Index index() throws IOException;
- // TODO: -- can we simplify this?
+ /** Records a single skip-point in the {@link IntIndexInput.Reader}. */
public abstract static class Index {
public abstract void read(DataInput indexIn, boolean absolute) throws IOException;
@@ -50,6 +50,7 @@ public abstract class IntIndexInput impl
public abstract Index clone();
}
+ /** Reads int values. */
public abstract static class Reader {
/** Reads next single int */
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexOutput.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexOutput.java?rev=1373992&r1=1373991&r2=1373992&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexOutput.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntIndexOutput.java Thu Aug 16 19:20:13 2012
@@ -38,6 +38,7 @@ public abstract class IntIndexOutput imp
* >= 0. */
public abstract void write(int v) throws IOException;
+ /** Records a single skip-point in the IndexOutput. */
public abstract static class Index {
/** Internally records the current location */
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntStreamFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntStreamFactory.java?rev=1373992&r1=1373991&r2=1373992&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntStreamFactory.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/sep/IntStreamFactory.java Thu Aug 16 19:20:13 2012
@@ -22,8 +22,15 @@ import org.apache.lucene.store.IOContext
import java.io.IOException;
-/** @lucene.experimental */
+/** Provides int reader and writer to specified files.
+ *
+ * @lucene.experimental */
public abstract class IntStreamFactory {
+ /** Create an {@link IntIndexInput} on the provided
+ * fileName. */
public abstract IntIndexInput openInput(Directory dir, String fileName, IOContext context) throws IOException;
+
+ /** Create an {@link IntIndexOutput} on the provided
+ * fileName. */
public abstract IntIndexOutput createOutput(Directory dir, String fileName, IOContext context) throws IOException;
}