|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.store.DataInput
org.apache.lucene.store.IndexInput
public abstract class IndexInput
Abstract base class for input from a file in a Directory
. A
random-access input stream. Used for all Lucene index input operations.
Directory
Constructor Summary | |
---|---|
protected |
IndexInput(String resourceDescription)
resourceDescription should be a non-null, opaque string describing this resource; it's returned from toString() . |
Method Summary | |
---|---|
abstract void |
close()
Closes the stream to further operations. |
void |
copyBytes(IndexOutput out,
long numBytes)
Copies numBytes bytes to the given IndexOutput . |
abstract long |
getFilePointer()
Returns the current position in this file, where the next read will occur. |
abstract long |
length()
The number of bytes in the file. |
abstract void |
seek(long pos)
Sets current position in this file, where the next read will occur. |
String |
toString()
|
Methods inherited from class org.apache.lucene.store.DataInput |
---|
clone, readByte, readBytes, readBytes, readInt, readLong, readShort, readString, readStringSet, readStringStringMap, readVInt, readVLong |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected IndexInput(String resourceDescription)
toString()
.
Method Detail |
---|
public abstract void close() throws IOException
close
in interface Closeable
IOException
public abstract long getFilePointer()
seek(long)
public abstract void seek(long pos) throws IOException
IOException
getFilePointer()
public abstract long length()
public void copyBytes(IndexOutput out, long numBytes) throws IOException
numBytes
bytes to the given IndexOutput
.
NOTE: this method uses an intermediate buffer to copy the bytes. Consider overriding it in your implementation, if you can make a better, optimized copy.
NOTE ensure that there are enough bytes in the input to copy to output. Otherwise, different exceptions may be thrown, depending on the implementation.
IOException
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |