Package org.apache.lucene.store
Class BufferedIndexOutput
- java.lang.Object
-
- org.apache.lucene.store.DataOutput
-
- org.apache.lucene.store.IndexOutput
-
- org.apache.lucene.store.BufferedIndexOutput
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
FSDirectory.FSIndexOutput
public abstract class BufferedIndexOutput extends IndexOutput
Base implementation class for bufferedIndexOutput
.
-
-
Constructor Summary
Constructors Constructor Description BufferedIndexOutput()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
close()
Closes this stream to further operations.void
flush()
Forces any buffered output to be written.protected abstract void
flushBuffer(byte[] b, int offset, int len)
Expert: implements buffer write.long
getFilePointer()
Returns the current position in this file, where the next write will occur.abstract long
length()
The number of bytes in the file.void
seek(long pos)
Sets current position in this file, where the next write will occur.void
writeByte(byte b)
Writes a single byte.void
writeBytes(byte[] b, int offset, int length)
Writes an array of bytes.-
Methods inherited from class org.apache.lucene.store.IndexOutput
setLength
-
Methods inherited from class org.apache.lucene.store.DataOutput
copyBytes, writeBytes, writeChars, writeChars, writeInt, writeLong, writeShort, writeString, writeStringStringMap, writeVInt, writeVLong
-
-
-
-
Method Detail
-
writeByte
public void writeByte(byte b) throws IOException
Writes a single byte.- Specified by:
writeByte
in classDataOutput
- Throws:
IOException
- See Also:
DataInput.readByte()
-
writeBytes
public void writeBytes(byte[] b, int offset, int length) throws IOException
Writes an array of bytes.- Specified by:
writeBytes
in classDataOutput
- Parameters:
b
- the bytes to writelength
- the number of bytes to writeoffset
- the offset in the byte array- Throws:
IOException
- See Also:
DataInput.readBytes(byte[],int,int)
-
flush
public void flush() throws IOException
Forces any buffered output to be written.- Specified by:
flush
in classIndexOutput
- Throws:
IOException
-
flushBuffer
protected abstract void flushBuffer(byte[] b, int offset, int len) throws IOException
Expert: implements buffer write. Writes bytes at the current position in the output.- Parameters:
b
- the bytes to writeoffset
- the offset in the byte arraylen
- the number of bytes to write- Throws:
IOException
-
close
public void close() throws IOException
Closes this stream to further operations.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classIndexOutput
- Throws:
IOException
-
getFilePointer
public long getFilePointer()
Returns the current position in this file, where the next write will occur.- Specified by:
getFilePointer
in classIndexOutput
- See Also:
seek(long)
-
seek
public void seek(long pos) throws IOException
Sets current position in this file, where the next write will occur.- Specified by:
seek
in classIndexOutput
- Throws:
IOException
- See Also:
getFilePointer()
-
length
public abstract long length() throws IOException
The number of bytes in the file.- Specified by:
length
in classIndexOutput
- Throws:
IOException
-
-