Package org.apache.lucene.store

Class FSDirectory.FSIndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

org.apache.lucene.store.BufferedIndexOutput

org.apache.lucene.store.FSDirectory.FSIndexOutput

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

FSDirectory

protected static class FSDirectory.FSIndexOutput
extends BufferedIndexOutput

Writes output with RandomAccessFile.write(byte[], int, int)

Field Summary

Fields inherited from class org.apache.lucene.store.BufferedIndexOutput

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
FSIndexOutput(FSDirectory parent, String name)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
protected void	flushBuffer(byte[] b, int offset, int size)	Expert: implements buffer write.
long	length()	The number of bytes in the file.
void	seek(long pos)	Random-access methods
void	setLength(long length)	Set the file length.

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

flush, getBufferSize, getFilePointer, writeByte, writeBytes

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

copyBytes, writeBytes, writeInt, writeLong, writeShort, writeString, writeStringSet, writeStringStringMap, writeVInt, writeVLong

Methods inherited from class java.lang.Object

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

Constructor Details

FSIndexOutput

public FSIndexOutput(FSDirectory parent,
 String name)
              throws IOException

Throws:

IOException

Method Details

flushBuffer

protected void flushBuffer(byte[] b,
 int offset,
 int size)
                    throws IOException

Description copied from class: BufferedIndexOutput

Expert: implements buffer write. Writes bytes at the current position in the output.

Specified by:

flushBuffer in class BufferedIndexOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

size - the number of bytes to write

Throws:

IOException

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

Overrides:

close in class BufferedIndexOutput

Throws:

IOException

seek

public void seek(long pos)
          throws IOException

Random-access methods

Overrides:

seek in class BufferedIndexOutput

Throws:

IOException

See Also:

• IndexOutput.getFilePointer()

length

public long length()
            throws IOException

Description copied from class: IndexOutput

The number of bytes in the file.

Specified by:

length in class BufferedIndexOutput

Throws:

IOException

setLength

public void setLength(long length)
               throws IOException

Description copied from class: IndexOutput

Set the file length. By default, this method does nothing (it's optional for a Directory to implement it). But, certain Directory implementations (for example @see FSDirectory) can use this to inform the underlying IO system to pre-allocate the file to the specified size. If the length is longer than the current file length, the bytes added to the file are undefined. Otherwise the file is truncated.

Overrides:

setLength in class IndexOutput

Parameters:

length - file length

Throws:

IOException