C# Class Lucene.Net.Store.IndexInput

Abstract base class for input from a file in a {@link Directory}. A random-access input stream. Used for all Lucene index input operations.
Inheritance: System.ICloneable
显示文件 Open project: apache/lucenenet Class Usage Examples

Public Methods

Method Description
Clone ( ) : object

{@inheritDoc}

Warning: Lucene never closes cloned {@code IndexInput}s, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

Dispose ( ) : void

Closes the stream to further operations.

Length ( ) : long

The number of bytes in the file.

Seek ( long pos ) : void

Sets current position in this file, where the next read will occur.

ToString ( ) : string

Protected Methods

Method Description
IndexInput ( string resourceDescription ) : System

resourceDescription should be a non-null, opaque string describing this resource; it's returned from #toString.

Method Details

Clone() public method

{@inheritDoc}

Warning: Lucene never closes cloned {@code IndexInput}s, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

public Clone ( ) : object
return object

Dispose() public abstract method

Closes the stream to further operations.
public abstract Dispose ( ) : void
return void

IndexInput() protected method

resourceDescription should be a non-null, opaque string describing this resource; it's returned from #toString.
protected IndexInput ( string resourceDescription ) : System
resourceDescription string
return System

Length() public abstract method

The number of bytes in the file.
public abstract Length ( ) : long
return long

Seek() public abstract method

Sets current position in this file, where the next read will occur.
public abstract Seek ( long pos ) : void
pos long
return void

ToString() public method

public ToString ( ) : string
return string