Class SegmentInfoReader

Specifies an API for classes that can read SegmentInfo information.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

SegmentInfoReader

Lucene3xSegmentInfoReader

Lucene40SegmentInfoReader

Lucene46SegmentInfoReader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs

Assembly: Lucene.Net.dll

Syntax

public abstract class SegmentInfoReader

Constructors

SegmentInfoReader()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration

protected SegmentInfoReader()

Methods

Read(Directory, string, IOContext)

Read SegmentInfo data from a directory.

Declaration

public abstract SegmentInfo Read(Directory directory, string segmentName, IOContext context)

Parameters

Type	Name	Description
Directory	directory	Directory to read from.
string	segmentName	Name of the segment to read.
IOContext	context	IO context.

Returns

Type	Description
SegmentInfo	Infos instance to be populated with data.

Exceptions

Type	Condition
IOException	If an I/O error occurs.