Package org.apache.lucene.store
Class OutputStreamIndexOutput
- java.lang.Object
-
- org.apache.lucene.store.DataOutput
-
- org.apache.lucene.store.IndexOutput
-
- org.apache.lucene.store.OutputStreamIndexOutput
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public class OutputStreamIndexOutput extends IndexOutput
Implementation class for bufferedIndexOutputthat writes to anOutputStream.
-
-
Constructor Summary
Constructors Constructor Description OutputStreamIndexOutput(String resourceDescription, String name, OutputStream out, int bufferSize)Creates a newOutputStreamIndexOutputwith the given buffer size.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes this stream to further operations.longgetChecksum()Returns the current checksum of bytes written so farlonggetFilePointer()Returns the current position in this file, where the next write will occur.voidwriteByte(byte b)Writes a single byte.voidwriteBytes(byte[] b, int offset, int length)Writes an array of bytes.voidwriteInt(int i)Writes an int as four bytes (LE byte order).voidwriteLong(long i)Writes a long as eight bytes (LE byte order).voidwriteShort(short i)Writes a short as two bytes (LE byte order).-
Methods inherited from class org.apache.lucene.store.IndexOutput
alignFilePointer, alignOffset, getName, toString
-
Methods inherited from class org.apache.lucene.store.DataOutput
copyBytes, writeBytes, writeGroupVInts, writeMapOfStrings, writeSetOfStrings, writeString, writeVInt, writeVLong, writeZInt, writeZLong
-
-
-
-
Constructor Detail
-
OutputStreamIndexOutput
public OutputStreamIndexOutput(String resourceDescription, String name, OutputStream out, int bufferSize)
Creates a newOutputStreamIndexOutputwith the given buffer size.- Parameters:
bufferSize- the buffer size in bytes used to buffer writes internally.- Throws:
IllegalArgumentException- if the given buffer size is less than8
-
-
Method Detail
-
writeByte
public final void writeByte(byte b) throws IOExceptionDescription copied from class:DataOutputWrites a single byte.The most primitive data type is an eight-bit byte. Files are accessed as sequences of bytes. All other data types are defined as sequences of bytes, so file formats are byte-order independent.
- Specified by:
writeBytein classDataOutput- Throws:
IOException- See Also:
DataInput.readByte()
-
writeBytes
public final void writeBytes(byte[] b, int offset, int length) throws IOExceptionDescription copied from class:DataOutputWrites an array of bytes.- Specified by:
writeBytesin classDataOutput- Parameters:
b- the bytes to writeoffset- the offset in the byte arraylength- the number of bytes to write- Throws:
IOException- See Also:
DataInput.readBytes(byte[],int,int)
-
writeShort
public void writeShort(short i) throws IOExceptionDescription copied from class:DataOutputWrites a short as two bytes (LE byte order).- Overrides:
writeShortin classDataOutput- Throws:
IOException- See Also:
DataInput.readShort(),BitUtil.VH_LE_SHORT
-
writeInt
public void writeInt(int i) throws IOExceptionDescription copied from class:DataOutputWrites an int as four bytes (LE byte order).- Overrides:
writeIntin classDataOutput- Throws:
IOException- See Also:
DataInput.readInt(),BitUtil.VH_LE_INT
-
writeLong
public void writeLong(long i) throws IOExceptionDescription copied from class:DataOutputWrites a long as eight bytes (LE byte order).- Overrides:
writeLongin classDataOutput- Throws:
IOException- See Also:
DataInput.readLong(),BitUtil.VH_LE_LONG
-
close
public void close() throws IOExceptionDescription copied from class:IndexOutputCloses this stream to further operations.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classIndexOutput- Throws:
IOException
-
getFilePointer
public final long getFilePointer()
Description copied from class:IndexOutputReturns the current position in this file, where the next write will occur.- Specified by:
getFilePointerin classIndexOutput
-
getChecksum
public final long getChecksum() throws IOExceptionDescription copied from class:IndexOutputReturns the current checksum of bytes written so far- Specified by:
getChecksumin classIndexOutput- Throws:
IOException
-
-