Class SegmentInfoFormat

  • Direct Known Subclasses:
    Lucene86SegmentInfoFormat

    public abstract class SegmentInfoFormat
    extends Object
    Expert: Controls the format of the SegmentInfo (segment metadata file).
    See Also:
    SegmentInfo
    WARNING: This API is experimental and might change in incompatible ways in the next release.
    • Constructor Detail

      • SegmentInfoFormat

        protected SegmentInfoFormat()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • read

        public abstract SegmentInfo read​(Directory directory,
                                         String segmentName,
                                         byte[] segmentID,
                                         IOContext context)
                                  throws IOException
        Read SegmentInfo data from a directory.
        Parameters:
        directory - directory to read from
        segmentName - name of the segment to read
        segmentID - expected identifier for the segment
        Returns:
        infos instance to be populated with data
        Throws:
        IOException - If an I/O error occurs