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 2012/08/16 16:14:39 UTC
svn commit: r1373851 - in /lucene/dev/trunk/lucene: ./
core/src/java/org/apache/lucene/codecs/memory/
core/src/java/org/apache/lucene/index/ core/src/java/org/apache/lucene/store/
core/src/test/org/apache/lucene/search/ test-framework/src/java/org/apac...
Author: rmuir
Date: Thu Aug 16 14:14:38 2012
New Revision: 1373851
URL: http://svn.apache.org/viewvc?rev=1373851&view=rev
Log:
add more missing javadocs
Modified:
lucene/dev/trunk/lucene/build.xml
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/memory/DirectPostingsFormat.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MergeState.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/RAMFile.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/TestSimilarityProvider.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockHoleInjectingTokenFilter.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockPayloadAnalyzer.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/lucene40ords/Lucene40WithOrds.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockFixedIntBlockPostingsFormat.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockVariableIntBlockPostingsFormat.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntFactory.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntIndexInput.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/AlcoholicMergePolicy.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/FieldFilterAtomicReader.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/ShardSearchingTestBase.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockDirectoryWrapper.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/English.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/RollingBuffer.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleFieldCacheSanity.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleStoreClassName.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/automaton/AutomatonTestUtil.java
Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Thu Aug 16 14:14:38 2012
@@ -247,7 +247,7 @@
<check-missing-javadocs dir="build/docs/sandbox" level="class"/>
<!-- spatial: problems -->
<check-missing-javadocs dir="build/docs/suggest" level="class"/>
- <!-- test-framework: problems -->
+ <check-missing-javadocs dir="build/docs/test-framework" level="class"/>
</sequential>
</target>
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/memory/DirectPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/memory/DirectPostingsFormat.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/memory/DirectPostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/memory/DirectPostingsFormat.java Thu Aug 16 14:14:38 2012
@@ -1796,7 +1796,7 @@ public class DirectPostingsFormat extend
}
// Docs + freqs:
- public final static class HighFreqDocsEnum extends DocsEnum {
+ private final static class HighFreqDocsEnum extends DocsEnum {
private int[] docIDs;
private int[] freqs;
private final Bits liveDocs;
@@ -1969,7 +1969,7 @@ public class DirectPostingsFormat extend
}
// TODO: specialize offsets and not
- public final static class HighFreqDocsAndPositionsEnum extends DocsAndPositionsEnum {
+ private final static class HighFreqDocsAndPositionsEnum extends DocsAndPositionsEnum {
private int[] docIDs;
private int[] freqs;
private int[][] positions;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MergeState.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MergeState.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MergeState.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MergeState.java Thu Aug 16 14:14:38 2012
@@ -29,6 +29,9 @@ import org.apache.lucene.util.packed.Pac
* @lucene.experimental */
public class MergeState {
+ /**
+ * Remaps docids around deletes during merge
+ */
public static abstract class DocMap {
private final Bits liveDocs;
@@ -197,6 +200,9 @@ public class MergeState {
public SegmentReader[] matchingSegmentReaders;
public int matchedCount;
+ /**
+ * Class for recording units of work when merging segments.
+ */
public static class CheckAbort {
private double workCount;
private final MergePolicy.OneMerge merge;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java Thu Aug 16 14:14:38 2012
@@ -43,7 +43,7 @@ import org.apache.lucene.util.packed.Pac
* @lucene.experimental
* @lucene.internal
*/
-public class MultiDocValues extends DocValues {
+class MultiDocValues extends DocValues {
private static DocValuesPuller DEFAULT_PULLER = new DocValuesPuller();
private static final DocValuesPuller NORMS_PULLER = new DocValuesPuller() {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java Thu Aug 16 14:14:38 2012
@@ -32,6 +32,9 @@ import org.apache.lucene.util.PriorityQu
import org.apache.lucene.util.packed.PackedInts;
/**
+ * Utility class for merging SortedBytes DocValues
+ * instances.
+ *
* @lucene.internal
*/
public final class SortedBytesMergeUtils {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java Thu Aug 16 14:14:38 2012
@@ -436,6 +436,9 @@ public abstract class FSDirectory extend
return chunkSize;
}
+ /**
+ * Writes output with {@link RandomAccessFile#write(byte[], int, int)}
+ */
protected static class FSIndexOutput extends BufferedIndexOutput {
private final FSDirectory parent;
private final String name;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java Thu Aug 16 14:14:38 2012
@@ -106,6 +106,9 @@ public class NIOFSDirectory extends FSDi
};
}
+ /**
+ * Reads bytes with {@link FileChannel#read(ByteBuffer, long)}
+ */
protected static class NIOFSIndexInput extends SimpleFSDirectory.SimpleFSIndexInput {
private ByteBuffer byteBuf; // wraps the buffer for NIO
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/RAMFile.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/RAMFile.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/RAMFile.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/RAMFile.java Thu Aug 16 14:14:38 2012
@@ -19,7 +19,9 @@ package org.apache.lucene.store;
import java.util.ArrayList;
-/** @lucene.internal */
+/**
+ * Represents a file in RAM as a list of byte[] buffers.
+ * @lucene.internal */
public class RAMFile {
protected ArrayList<byte[]> buffers = new ArrayList<byte[]>();
long length;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java Thu Aug 16 14:14:38 2012
@@ -85,8 +85,16 @@ public class SimpleFSDirectory extends F
};
}
+ /**
+ * Reads bytes with {@link RandomAccessFile#seek(long)} followed by
+ * {@link RandomAccessFile#read(byte[], int, int)}.
+ */
protected static class SimpleFSIndexInput extends BufferedIndexInput {
+ /**
+ * Extension of RandomAccessFile that tracks if the file is
+ * open.
+ */
protected static class Descriptor extends RandomAccessFile {
// remember if the file is open, so that we don't try to close it
// more than once
Modified: lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/TestSimilarityProvider.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/TestSimilarityProvider.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/TestSimilarityProvider.java (original)
+++ lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/TestSimilarityProvider.java Thu Aug 16 14:14:38 2012
@@ -20,12 +20,13 @@ package org.apache.lucene.search;
import org.apache.lucene.analysis.MockAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
+import org.apache.lucene.index.AtomicReader;
+import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.index.FieldInvertState;
-import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriterConfig;
-import org.apache.lucene.index.MultiDocValues;
import org.apache.lucene.index.Norm;
import org.apache.lucene.index.RandomIndexWriter;
+import org.apache.lucene.index.SlowCompositeReaderWrapper;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.similarities.PerFieldSimilarityWrapper;
import org.apache.lucene.search.similarities.Similarity;
@@ -36,7 +37,7 @@ import org.apache.lucene.util.LuceneTest
public class TestSimilarityProvider extends LuceneTestCase {
private Directory directory;
- private IndexReader reader;
+ private DirectoryReader reader;
private IndexSearcher searcher;
@Override
@@ -75,8 +76,9 @@ public class TestSimilarityProvider exte
public void testBasics() throws Exception {
// sanity check of norms writer
// TODO: generalize
- byte fooNorms[] = (byte[]) MultiDocValues.getNormDocValues(reader, "foo").getSource().getArray();
- byte barNorms[] = (byte[]) MultiDocValues.getNormDocValues(reader, "bar").getSource().getArray();
+ AtomicReader slow = new SlowCompositeReaderWrapper(reader);
+ byte fooNorms[] = (byte[]) slow.normValues("foo").getSource().getArray();
+ byte barNorms[] = (byte[]) slow.normValues("bar").getSource().getArray();
for (int i = 0; i < fooNorms.length; i++) {
assertFalse(fooNorms[i] == barNorms[i]);
}
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockHoleInjectingTokenFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockHoleInjectingTokenFilter.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockHoleInjectingTokenFilter.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockHoleInjectingTokenFilter.java Thu Aug 16 14:14:38 2012
@@ -29,7 +29,9 @@ import org.apache.lucene.util._TestUtil;
// a MockRemovesTokensTF, ideally subclassing FilteringTF
// (in modules/analysis)
-// Randomly injects holes:
+/**
+ * Randomly injects holes (similar to what a stopfilter would do)
+ */
public final class MockHoleInjectingTokenFilter extends TokenFilter {
private final long randomSeed;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockPayloadAnalyzer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockPayloadAnalyzer.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockPayloadAnalyzer.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockPayloadAnalyzer.java Thu Aug 16 14:14:38 2012
@@ -27,8 +27,9 @@ import java.io.Reader;
/**
- *
- *
+ * Wraps a whitespace tokenizer with a filter that sets
+ * the first token, and odd tokens to posinc=1, and all others
+ * to 0, encoding the position as pos: XXX in the payload.
**/
public final class MockPayloadAnalyzer extends Analyzer {
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/lucene40ords/Lucene40WithOrds.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/lucene40ords/Lucene40WithOrds.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/lucene40ords/Lucene40WithOrds.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/lucene40ords/Lucene40WithOrds.java Thu Aug 16 14:14:38 2012
@@ -30,6 +30,7 @@ import org.apache.lucene.codecs.Postings
import org.apache.lucene.codecs.PostingsWriterBase;
import org.apache.lucene.codecs.TermsIndexReaderBase;
import org.apache.lucene.codecs.TermsIndexWriterBase;
+import org.apache.lucene.codecs.lucene40.Lucene40Codec; // javadocs
import org.apache.lucene.codecs.lucene40.Lucene40PostingsReader;
import org.apache.lucene.codecs.lucene40.Lucene40PostingsWriter;
import org.apache.lucene.index.SegmentReadState;
@@ -39,6 +40,10 @@ import org.apache.lucene.util.BytesRef;
// TODO: we could make separate base class that can wrapp
// any PostingsBaseFormat and make it ord-able...
+/**
+ * Customized version of {@link Lucene40Codec} that uses
+ * {@link FixedGapTermsIndexWriter}.
+ */
public class Lucene40WithOrds extends PostingsFormat {
public Lucene40WithOrds() {
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockFixedIntBlockPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockFixedIntBlockPostingsFormat.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockFixedIntBlockPostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockFixedIntBlockPostingsFormat.java Thu Aug 16 14:14:38 2012
@@ -72,6 +72,9 @@ public class MockFixedIntBlockPostingsFo
return new MockIntFactory(blockSize);
}
+ /**
+ * Encodes blocks as vInts of a fixed block size.
+ */
public static class MockIntFactory extends IntStreamFactory {
private final int blockSize;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockVariableIntBlockPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockVariableIntBlockPostingsFormat.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockVariableIntBlockPostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mockintblock/MockVariableIntBlockPostingsFormat.java Thu Aug 16 14:14:38 2012
@@ -70,6 +70,10 @@ public class MockVariableIntBlockPosting
return getName() + "(baseBlockSize="+ baseBlockSize + ")";
}
+ /**
+ * If the first value is <= 3, writes baseBlockSize vInts at once,
+ * otherwise writes 2*baseBlockSize vInts.
+ */
public static class MockIntFactory extends IntStreamFactory {
private final int baseBlockSize;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntFactory.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntFactory.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntFactory.java Thu Aug 16 14:14:38 2012
@@ -25,7 +25,10 @@ import org.apache.lucene.codecs.sep.IntS
import java.io.IOException;
-/** @lucene.experimental */
+/**
+ * Encodes ints directly as vInts with {@link MockSingleIntIndexOutput}
+ * @lucene.experimental
+ */
public class MockSingleIntFactory extends IntStreamFactory {
@Override
public IntIndexInput openInput(Directory dir, String fileName, IOContext context) throws IOException {
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntIndexInput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntIndexInput.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntIndexInput.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/codecs/mocksep/MockSingleIntIndexInput.java Thu Aug 16 14:14:38 2012
@@ -28,7 +28,7 @@ import org.apache.lucene.store.IndexInpu
/** Reads IndexInputs written with {@link
* MockSingleIntIndexOutput}. NOTE: this class is just for
- * demonstration puprposes (it is a very slow way to read a
+ * demonstration purposes (it is a very slow way to read a
* block of ints).
*
* @lucene.experimental
@@ -54,6 +54,9 @@ public class MockSingleIntIndexInput ext
in.close();
}
+ /**
+ * Just reads a vInt directly from the file.
+ */
public static class Reader extends IntIndexInput.Reader {
// clone:
private final IndexInput in;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/AlcoholicMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/AlcoholicMergePolicy.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/AlcoholicMergePolicy.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/AlcoholicMergePolicy.java Thu Aug 16 14:14:38 2012
@@ -68,7 +68,7 @@ public class AlcoholicMergePolicy extend
return info.sizeInBytes();
}
- public static enum Drink {
+ private static enum Drink {
Beer(15), Wine(17), Champagne(21), WhiteRussian(22), SingleMalt(30);
@@ -77,11 +77,6 @@ public class AlcoholicMergePolicy extend
Drink(long drunkFactor) {
this.drunkFactor = drunkFactor;
}
-
- public long drunk() {
- return drunkFactor;
- }
-
}
}
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/FieldFilterAtomicReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/FieldFilterAtomicReader.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/FieldFilterAtomicReader.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/FieldFilterAtomicReader.java Thu Aug 16 14:14:38 2012
@@ -23,6 +23,10 @@ import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.Set;
+/**
+ * A {@link FilterAtomicReader} that exposes only a subset
+ * of fields from the underlying wrapped reader.
+ */
public final class FieldFilterAtomicReader extends FilterAtomicReader {
private final Set<String> fields;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/ShardSearchingTestBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/ShardSearchingTestBase.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/ShardSearchingTestBase.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/ShardSearchingTestBase.java Thu Aug 16 14:14:38 2012
@@ -42,9 +42,15 @@ import org.apache.lucene.util._TestUtil;
// - doc blocks? so we can test joins/grouping...
// - controlled consistency (NRTMgr)
+/**
+ * Base test class for simulating distributed search across multiple shards.
+ */
public abstract class ShardSearchingTestBase extends LuceneTestCase {
// TODO: maybe SLM should throw this instead of returning null...
+ /**
+ * Thrown when the lease for a searcher has expired.
+ */
public static class SearcherExpiredException extends RuntimeException {
public SearcherExpiredException(String message) {
super(message);
@@ -604,6 +610,9 @@ public abstract class ShardSearchingTest
}
}
+ /**
+ * An IndexSearcher and associated version (lease)
+ */
protected static class SearcherAndVersion {
public final IndexSearcher searcher;
public final long version;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockDirectoryWrapper.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockDirectoryWrapper.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockDirectoryWrapper.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockDirectoryWrapper.java Thu Aug 16 14:14:38 2012
@@ -146,6 +146,12 @@ public class MockDirectoryWrapper extend
preventDoubleWrite = value;
}
+ /**
+ * Enum for controlling hard disk throttling.
+ * Set via {@link MockDirectoryWrapper #setThrottling(Throttling)}
+ * <p>
+ * WARNING: can make tests very slow.
+ */
public static enum Throttling {
/** always emulate a slow hard disk. could be very slow! */
ALWAYS,
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/English.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/English.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/English.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/English.java Thu Aug 16 14:14:38 2012
@@ -18,6 +18,7 @@ package org.apache.lucene.util;
*/
/**
+ * Converts numbers to english strings for testing.
* @lucene.internal
*/
public final class English {
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/RollingBuffer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/RollingBuffer.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/RollingBuffer.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/RollingBuffer.java Thu Aug 16 14:14:38 2012
@@ -26,6 +26,9 @@ package org.apache.lucene.util;
* @lucene.internal */
public abstract class RollingBuffer<T extends RollingBuffer.Resettable> {
+ /**
+ * Implement to reset an instance
+ */
public static interface Resettable {
public void reset();
}
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleFieldCacheSanity.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleFieldCacheSanity.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleFieldCacheSanity.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleFieldCacheSanity.java Thu Aug 16 14:14:38 2012
@@ -1,10 +1,5 @@
package org.apache.lucene.util;
-import org.apache.lucene.search.FieldCache;
-import org.junit.rules.TestRule;
-import org.junit.runner.Description;
-import org.junit.runners.model.Statement;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -22,6 +17,30 @@ import org.junit.runners.model.Statement
* limitations under the License.
*/
+import org.apache.lucene.search.FieldCache;
+import org.apache.lucene.util.FieldCacheSanityChecker; // javadocs
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+/**
+ * This rule will fail the test if it has insane field caches.
+ * <p>
+ * calling assertSaneFieldCaches here isn't as useful as having test
+ * classes call it directly from the scope where the index readers
+ * are used, because they could be gc'ed just before this tearDown
+ * method is called.
+ * <p>
+ * But it's better then nothing.
+ * <p>
+ * If you are testing functionality that you know for a fact
+ * "violates" FieldCache sanity, then you should either explicitly
+ * call purgeFieldCache at the end of your test method, or refactor
+ * your Test class so that the inconsistent FieldCache usages are
+ * isolated in distinct test methods
+ *
+ * @see FieldCacheSanityChecker
+ */
public class TestRuleFieldCacheSanity implements TestRule {
@Override
@@ -33,18 +52,6 @@ public class TestRuleFieldCacheSanity im
Throwable problem = null;
try {
- // calling assertSaneFieldCaches here isn't as useful as having test
- // classes call it directly from the scope where the index readers
- // are used, because they could be gc'ed just before this tearDown
- // method is called.
- //
- // But it's better then nothing.
- //
- // If you are testing functionality that you know for a fact
- // "violates" FieldCache sanity, then you should either explicitly
- // call purgeFieldCache at the end of your test method, or refactor
- // your Test class so that the inconsistent FieldCache usages are
- // isolated in distinct test methods
LuceneTestCase.assertSaneFieldCaches(d.getDisplayName());
} catch (Throwable t) {
problem = t;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleStoreClassName.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleStoreClassName.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleStoreClassName.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/TestRuleStoreClassName.java Thu Aug 16 14:14:38 2012
@@ -21,6 +21,10 @@ import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
+/**
+ * Stores the suite name so you can retrieve it
+ * from {@link #getTestClass()}
+ */
public class TestRuleStoreClassName implements TestRule {
private volatile Description description;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/automaton/AutomatonTestUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/automaton/AutomatonTestUtil.java?rev=1373851&r1=1373850&r2=1373851&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/automaton/AutomatonTestUtil.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/automaton/AutomatonTestUtil.java Thu Aug 16 14:14:38 2012
@@ -127,6 +127,13 @@ public class AutomatonTestUtil {
return code;
}
+ /**
+ * Lets you retrieve random strings accepted
+ * by an Automaton.
+ * <p>
+ * Once created, call {@link #getRandomAcceptedString(Random)}
+ * to get a new string (in UTF-32 codepoints).
+ */
public static class RandomAcceptedStrings {
private final Map<Transition,Boolean> leadsToAccept;