LUCENE-5969: javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene5969@1629406 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2014-10-04 15:51:31 +00:00
parent 3bc0d0b151
commit 206fb874bc
5 changed files with 17 additions and 2 deletions

View File

@ -34,6 +34,10 @@ import org.apache.lucene.store.IOContext;
@Deprecated
public final class Lucene40CompoundFormat extends CompoundFormat {
/** Sole constructor. */
public Lucene40CompoundFormat() {
}
@Override
public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {
String fileName = IndexFileNames.segmentFileName(si.name, "", COMPOUND_FILE_EXTENSION);

View File

@ -50,6 +50,10 @@ import org.apache.lucene.util.StringHelper;
*/
public class SimpleTextCompoundFormat extends CompoundFormat {
/** Sole constructor. */
public SimpleTextCompoundFormat() {
}
@Override
public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {
String dataFile = IndexFileNames.segmentFileName(si.name, "", DATA_EXTENSION);

View File

@ -50,6 +50,9 @@ public abstract class CompoundFormat {
// TODO: get checkAbort out of here, and everywhere, and have iw do it at a higher level
public abstract void write(Directory dir, SegmentInfo si, Collection<String> files, CheckAbort checkAbort, IOContext context) throws IOException;
/**
* Returns the compound file names used by this segment.
*/
// TODO: get this out of here, and use trackingdirwrapper. but this is really scary in IW right now...
// NOTE: generally si.useCompoundFile is not even yet 'set' when this is called.
public abstract String[] files(SegmentInfo si);

View File

@ -63,6 +63,10 @@ import org.apache.lucene.store.IndexOutput;
*/
public final class Lucene50CompoundFormat extends CompoundFormat {
/** Sole constructor. */
public Lucene50CompoundFormat() {
}
@Override
public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {
return new Lucene50CompoundReader(dir, si, context);

View File

@ -243,7 +243,7 @@ file.</td>
<td>Stores metadata about a segment</td>
</tr>
<tr>
<td>{@link org.apache.lucene.codecs.lucene50.LUcene50CompoundFormat Compound File}</td>
<td>{@link org.apache.lucene.codecs.lucene50.Lucene50CompoundFormat Compound File}</td>
<td>.cfs, .cfe</td>
<td>An optional "virtual" file consisting of all the other index files for
systems that frequently run out of file handles.</td>