svn commit: r1299510 - in /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs: Codec.java perfield/PerFieldPostingsFormat.java

[rm...@apache.org]

Author: rmuir
Date: Mon Mar 12 00:51:07 2012
New Revision: 1299510

URL: http://svn.apache.org/viewvc?rev=1299510&view=rev
Log:
add javadocs pointers to SPI for Codec/PostingsFormat

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/Codec.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/Codec.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/Codec.java?rev=1299510&r1=1299509&r2=1299510&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/Codec.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/Codec.java Mon Mar 12 00:51:07 2012
@@ -19,6 +19,7 @@ package org.apache.lucene.codecs;
 
 import java.io.IOException;
 import java.util.Set;
+import java.util.ServiceLoader; // javadocs
 
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.IndexWriterConfig; // javadocs
@@ -26,7 +27,15 @@ import org.apache.lucene.index.SegmentIn
 import org.apache.lucene.util.NamedSPILoader;
 
 /**
- * Encodes/decodes an inverted index segment
+ * Encodes/decodes an inverted index segment.
+ * <p>
+ * Note, when extending this class, the name ({@link #getName}) is 
+ * written into the index. In order for the segment to be read, the
+ * name must resolve to your implementation via {@link #forName(String)}.
+ * This method uses Java's 
+ * {@link ServiceLoader Service Provider Interface} to resolve codec names.
+ * <p>
+ * @see ServiceLoader
  */
 public abstract class Codec implements NamedSPILoader.NamedSPI {
 

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java?rev=1299510&r1=1299509&r2=1299510&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java Mon Mar 12 00:51:07 2012
@@ -24,6 +24,7 @@ import java.util.HashMap;
 import java.util.IdentityHashMap;
 import java.util.Iterator;
 import java.util.Map;
+import java.util.ServiceLoader; // javadocs
 import java.util.Set;
 import java.util.TreeMap;
 
@@ -47,7 +48,14 @@ import org.apache.lucene.util.IOUtils;
 
 /**
  * Enables per field format support.
- * 
+ * <p>
+ * Note, when extending this class, the name ({@link #getName}) is 
+ * written into the index. In order for the field to be read, the
+ * name must resolve to your implementation via {@link #forName(String)}.
+ * This method uses Java's 
+ * {@link ServiceLoader Service Provider Interface} to resolve format names.
+ * <p>
+ * @see ServiceLoader
  * @lucene.experimental
  */