mirror of
https://github.com/apache/lucene.git
synced 2025-03-07 00:39:21 +00:00
add javadocs pointers to SPI for Codec/PostingsFormat
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1299510 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
b075b7466c
commit
687f68afad
@ -19,6 +19,7 @@ package org.apache.lucene.codecs;
|
|||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
import java.util.ServiceLoader; // javadocs
|
||||||
|
|
||||||
import org.apache.lucene.index.IndexFileNames;
|
import org.apache.lucene.index.IndexFileNames;
|
||||||
import org.apache.lucene.index.IndexWriterConfig; // javadocs
|
import org.apache.lucene.index.IndexWriterConfig; // javadocs
|
||||||
@ -26,7 +27,15 @@ import org.apache.lucene.index.SegmentInfo;
|
|||||||
import org.apache.lucene.util.NamedSPILoader;
|
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 {
|
public abstract class Codec implements NamedSPILoader.NamedSPI {
|
||||||
|
|
||||||
|
@ -24,6 +24,7 @@ import java.util.HashMap;
|
|||||||
import java.util.IdentityHashMap;
|
import java.util.IdentityHashMap;
|
||||||
import java.util.Iterator;
|
import java.util.Iterator;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
import java.util.ServiceLoader; // javadocs
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.TreeMap;
|
import java.util.TreeMap;
|
||||||
|
|
||||||
@ -47,7 +48,14 @@ import org.apache.lucene.util.IOUtils;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Enables per field format support.
|
* 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
|
* @lucene.experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user