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:

java.io.Closeable, java.lang.AutoCloseable

public final class ByteBuffersIndexOutput
extends IndexOutput

An IndexOutput writing to a ByteBuffersDataOutput.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.zip.Checksum	checksum
private ByteBuffersDataOutput	delegate
private long	lastChecksum
private long	lastChecksumPosition
private java.util.function.Consumer<ByteBuffersDataOutput>	onClose

Constructor Summary

Constructors

Constructor	Description
ByteBuffersIndexOutput(ByteBuffersDataOutput delegate, java.lang.String resourceDescription, java.lang.String name)
ByteBuffersIndexOutput(ByteBuffersDataOutput delegate, java.lang.String resourceDescription, java.lang.String name, java.util.zip.Checksum checksum, java.util.function.Consumer<ByteBuffersDataOutput> onClose)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
void	copyBytes(DataInput input, long numBytes)	Copy numBytes bytes from input to ourself.
private void	ensureOpen()
long	getChecksum()	Returns the current checksum of bytes written so far
long	getFilePointer()	Returns the current position in this file, where the next write will occur.
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int length)	Writes an array of bytes.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeInt(int i)	Writes an int as four bytes.
void	writeLong(long i)	Writes a long as eight bytes.
void	writeMapOfStrings(java.util.Map<java.lang.String,java.lang.String> map)	Writes a String map.
void	writeSetOfStrings(java.util.Set<java.lang.String> set)	Writes a String set.
void	writeShort(short i)	Writes a short as two bytes.
void	writeString(java.lang.String s)	Writes a string.

Methods inherited from class org.apache.lucene.store.IndexOutput

getName, toString

Methods inherited from class org.apache.lucene.store.DataOutput

writeVInt, writeVLong, writeZInt, writeZLong

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

onClose

private final java.util.function.Consumer<ByteBuffersDataOutput> onClose

checksum

private final java.util.zip.Checksum checksum

lastChecksumPosition

private long lastChecksumPosition

lastChecksum

private long lastChecksum

delegate

private ByteBuffersDataOutput delegate

Constructor Detail

ByteBuffersIndexOutput

public ByteBuffersIndexOutput(ByteBuffersDataOutput delegate,
                              java.lang.String resourceDescription,
                              java.lang.String name)

ByteBuffersIndexOutput

public ByteBuffersIndexOutput(ByteBuffersDataOutput delegate,
                              java.lang.String resourceDescription,
                              java.lang.String name,
                              java.util.zip.Checksum checksum,
                              java.util.function.Consumer<ByteBuffersDataOutput> onClose)

Method Detail

close

public void close()
           throws java.io.IOException

Description copied from class: IndexOutput

Closes this stream to further operations.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in class IndexOutput

Throws:

java.io.IOException

getFilePointer

public long getFilePointer()

Description copied from class: IndexOutput

Returns the current position in this file, where the next write will occur.

Specified by:

getFilePointer in class IndexOutput

getChecksum

public long getChecksum()
                 throws java.io.IOException

Description copied from class: IndexOutput

Returns the current checksum of bytes written so far

Specified by:

getChecksum in class IndexOutput

Throws:

java.io.IOException

writeByte

public void writeByte(byte b)
               throws java.io.IOException

Description copied from class: DataOutput

Writes 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:

writeByte in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readByte()

writeBytes

public void writeBytes(byte[] b,
                       int offset,
                       int length)
                throws java.io.IOException

Description copied from class: DataOutput

Writes an array of bytes.

Specified by:

writeBytes in class DataOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

Throws:

java.io.IOException

See Also:

DataInput.readBytes(byte[],int,int)

writeBytes

public void writeBytes(byte[] b,
                       int length)
                throws java.io.IOException

Description copied from class: DataOutput

Writes an array of bytes.

Overrides:

writeBytes in class DataOutput

Parameters:

b - the bytes to write

length - the number of bytes to write

Throws:

java.io.IOException

See Also:

DataInput.readBytes(byte[],int,int)

writeInt

public void writeInt(int i)
              throws java.io.IOException

Description copied from class: DataOutput

Writes an int as four bytes.

32-bit unsigned integer written as four bytes, high-order bytes first.

Overrides:

writeInt in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readInt()

writeShort

public void writeShort(short i)
                throws java.io.IOException

Description copied from class: DataOutput

Writes a short as two bytes.

Overrides:

writeShort in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readShort()

writeLong

public void writeLong(long i)
               throws java.io.IOException

Description copied from class: DataOutput

Writes a long as eight bytes.

64-bit unsigned integer written as eight bytes, high-order bytes first.

Overrides:

writeLong in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readLong()

writeString

public void writeString(java.lang.String s)
                 throws java.io.IOException

Description copied from class: DataOutput

Writes a string.

Writes strings as UTF-8 encoded bytes. First the length, in bytes, is written as a VInt, followed by the bytes.

Overrides:

writeString in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readString()

copyBytes

public void copyBytes(DataInput input,
                      long numBytes)
               throws java.io.IOException

Description copied from class: DataOutput

Copy numBytes bytes from input to ourself.

Overrides:

copyBytes in class DataOutput

Throws:

java.io.IOException

writeMapOfStrings

public void writeMapOfStrings(java.util.Map<java.lang.String,java.lang.String> map)
                       throws java.io.IOException

Description copied from class: DataOutput

Writes a String map.

First the size is written as an vInt, followed by each key-value pair written as two consecutive Strings.

Overrides:

writeMapOfStrings in class DataOutput

Parameters:

map - Input map.

Throws:

java.io.IOException

writeSetOfStrings

public void writeSetOfStrings(java.util.Set<java.lang.String> set)
                       throws java.io.IOException

Description copied from class: DataOutput

Writes a String set.

First the size is written as an vInt, followed by each value written as a String.

Overrides:

writeSetOfStrings in class DataOutput

Parameters:

set - Input set.

Throws:

java.io.IOException

ensureOpen

private void ensureOpen()