Module org.apache.lucene.misc

Package org.apache.lucene.misc.store

Class DirectIODirectory.DirectIOIndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

org.apache.lucene.misc.store.DirectIODirectory.DirectIOIndexOutput

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

DirectIODirectory

private static final class DirectIODirectory.DirectIOIndexOutput
extends IndexOutput

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	buffer
private final FileChannel	channel
private final Checksum	digest
private long	filePos
private boolean	isOpen

Constructor Summary

Constructors

Constructor	Description
DirectIOIndexOutput(Path path, String name, int blockSize, int bufferSize)	Creates a new instance of DirectIOIndexOutput for writing index output with direct IO bypassing OS buffer

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
private void	dump()
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[] src, int offset, int len)	Writes an array of bytes.

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, writeInt, writeLong, writeMapOfStrings, writeSetOfStrings, writeShort, writeString, writeVInt, writeVLong, writeZInt, writeZLong

Methods inherited from class java.lang.Object

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

Field Details

buffer

private final ByteBuffer buffer

channel

private final FileChannel channel

digest

private final Checksum digest

filePos

private long filePos

isOpen

private boolean isOpen

Constructor Details

DirectIOIndexOutput

public DirectIOIndexOutput(Path path,
 String name,
 int blockSize,
 int bufferSize)
                    throws IOException

Creates a new instance of DirectIOIndexOutput for writing index output with direct IO bypassing OS buffer

Throws:

UnsupportedOperationException - if the JDK does not support Direct I/O

IOException - if the operating system or filesystem does not support support Direct I/O or a sufficient equivalent.

Method Details

writeByte

public void writeByte(byte b)
               throws 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:

IOException

See Also:

• DataInput.readByte()

writeBytes

public void writeBytes(byte[] src,
 int offset,
 int len)
                throws IOException

Description copied from class: DataOutput

Writes an array of bytes.

Specified by:

writeBytes in class DataOutput

Parameters:

src - the bytes to write

offset - the offset in the byte array

len - the number of bytes to write

Throws:

IOException

See Also:

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

dump

private void dump()
           throws IOException

Throws:

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()

Description copied from class: IndexOutput

Returns the current checksum of bytes written so far

Specified by:

getChecksum in class IndexOutput

close

public void close()
           throws IOException

Description copied from class: IndexOutput

Closes this stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class IndexOutput

Throws:

IOException