Package org.apache.lucene.store
Class ByteBuffersIndexOutput
java.lang.Object
org.apache.lucene.store.DataOutput
org.apache.lucene.store.IndexOutput
org.apache.lucene.store.ByteBuffersIndexOutput
- All Implemented Interfaces:
Closeable,AutoCloseable
An
IndexOutput writing to a ByteBuffersDataOutput.-
Constructor Summary
ConstructorsConstructorDescriptionByteBuffersIndexOutput(ByteBuffersDataOutput delegate, String resourceDescription, String name) ByteBuffersIndexOutput(ByteBuffersDataOutput delegate, String resourceDescription, String name, Checksum checksum, Consumer<ByteBuffersDataOutput> onClose) -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes this stream to further operations.voidCopy numBytes bytes from input to ourself.longReturns the current checksum of bytes written so farlongReturns the current position in this file, where the next write will occur.byte[]voidwriteByte(byte b) Writes a single byte.voidwriteBytes(byte[] b, int length) Writes an array of bytes.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).voidwriteMapOfStrings(Map<String, String> map) Writes a String map.voidwriteSetOfStrings(Set<String> set) Writes a String set.voidwriteShort(short i) Writes a short as two bytes (LE byte order).voidWrites a string.Methods inherited from class org.apache.lucene.store.IndexOutput
alignFilePointer, alignOffset, getName, toStringMethods inherited from class org.apache.lucene.store.DataOutput
writeGroupVInts, writeGroupVInts, writeVInt, writeVLong, writeZInt, writeZLong
-
Constructor Details
-
ByteBuffersIndexOutput
public ByteBuffersIndexOutput(ByteBuffersDataOutput delegate, String resourceDescription, String name) -
ByteBuffersIndexOutput
public ByteBuffersIndexOutput(ByteBuffersDataOutput delegate, String resourceDescription, String name, Checksum checksum, Consumer<ByteBuffersDataOutput> onClose)
-
-
Method Details
-
close
Description 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 long getFilePointer()Description copied from class:IndexOutputReturns the current position in this file, where the next write will occur.- Specified by:
getFilePointerin classIndexOutput
-
getChecksum
Description copied from class:IndexOutputReturns the current checksum of bytes written so far- Specified by:
getChecksumin classIndexOutput- Throws:
IOException
-
writeByte
Description 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:
-
writeBytes
Description 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:
-
writeBytes
Description copied from class:DataOutputWrites an array of bytes.- Overrides:
writeBytesin classDataOutput- Parameters:
b- the bytes to writelength- the number of bytes to write- Throws:
IOException- See Also:
-
writeInt
Description copied from class:DataOutputWrites an int as four bytes (LE byte order).- Overrides:
writeIntin classDataOutput- Throws:
IOException- See Also:
-
writeShort
Description copied from class:DataOutputWrites a short as two bytes (LE byte order).- Overrides:
writeShortin classDataOutput- Throws:
IOException- See Also:
-
writeLong
Description copied from class:DataOutputWrites a long as eight bytes (LE byte order).- Overrides:
writeLongin classDataOutput- Throws:
IOException- See Also:
-
writeString
Description copied from class:DataOutputWrites a string.Writes strings as UTF-8 encoded bytes. First the length, in bytes, is written as a
VInt, followed by the bytes.- Overrides:
writeStringin classDataOutput- Throws:
IOException- See Also:
-
copyBytes
Description copied from class:DataOutputCopy numBytes bytes from input to ourself.- Overrides:
copyBytesin classDataOutput- Throws:
IOException
-
writeMapOfStrings
Description copied from class:DataOutputWrites a String map.First the size is written as an
vInt, followed by each key-value pair written as two consecutiveStrings.- Overrides:
writeMapOfStringsin classDataOutput- Parameters:
map- Input map.- Throws:
IOException
-
writeSetOfStrings
Description copied from class:DataOutputWrites a String set.First the size is written as an
vInt, followed by each value written as aString.- Overrides:
writeSetOfStringsin classDataOutput- Parameters:
set- Input set.- Throws:
IOException
-
toArrayCopy
public byte[] toArrayCopy()
-