Apache Lucene.Net 2.4.0 Class Library API

IndexInput Methods

The methods of the IndexInput class are listed below. For a complete list of IndexInput class members, see the IndexInput Members topic.

Public Instance Methods

Clone 
CloseCloses the stream to futher operations.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetFilePointerReturns the current position in this file, where the next read will occur.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
LengthThe number of bytes in the file.
ReadByteReads and returns a single byte.
ReadBytesOverloaded. Reads a specified number of bytes into an array at the specified offset.
ReadCharsObsolete. Reads Lucene's old "modified UTF-8" encoded characters into an array.
ReadIntReads four bytes and returns an int.
ReadLongReads eight bytes and returns a long.
ReadModifiedUTF8String 
ReadStringReads a string.
ReadVIntReads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
ReadVLongReads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.
SeekSets current position in this file, where the next read will occur.
SetModifiedUTF8StringsMode Set to read strings in the deprecated modified UTF-8 format (length in Java chars and Java's modified UTF-8 encoding). Used for pre-2.4.0 indexes. See JIRA LUCENE-510 for details.
SkipCharsObsolete. Expert Similar to {@link #ReadChars(char[], int, int)} but does not do any conversion operations on the bytes it is reading in. It still has to invoke {@link #ReadByte()} just as {@link #ReadChars(char[], int, int)} does, but it does not need a buffer to store anything and it does not have to do any of the bitwise operations, since we don't actually care what is in the byte except to determine how many more bytes to read
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

IndexInput Class | Lucene.Net.Store Namespace |