org.apache.lucene.store

Class IndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

CorruptingIndexOutput, MockIndexOutputWrapper, OutputStreamIndexOutput, RAMOutputStream, RateLimitedIndexOutput, ThrottledIndexOutput

public abstract class IndexOutput
extends DataOutput
implements java.io.Closeable

Abstract base class for output to a file in a Directory. A random-access output stream. Used for all Lucene index output operations.

IndexOutput may only be used from one thread, because it is not thread safe (it keeps internal state like file position).

See Also:

Directory, IndexInput

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexOutput(java.lang.String resourceDescription, java.lang.String name) Sole constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this stream to further operations.
abstract long	getChecksum() Returns the current checksum of bytes written so far
abstract long	getFilePointer() Returns the current position in this file, where the next write will occur.
java.lang.String	getName() Returns the name used to create this IndexOutput.
java.lang.String	toString()

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

copyBytes, writeByte, writeBytes, writeBytes, writeInt, writeLong, writeMapOfStrings, writeSetOfStrings, writeShort, writeString, writeStringSet, writeStringStringMap, writeVInt, writeVLong, writeZInt, writeZLong

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexOutput

protected IndexOutput(java.lang.String resourceDescription,
                      java.lang.String name)

Sole constructor. resourceDescription should be non-null, opaque string describing this resource; it's returned from toString().

Method Detail

getName

public java.lang.String getName()

Returns the name used to create this IndexOutput. This is especially useful when using Directory.createTempOutput(java.lang.String, java.lang.String, org.apache.lucene.store.IOContext).

close

public abstract void close()
                    throws java.io.IOException

Closes this stream to further operations.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getFilePointer

public abstract long getFilePointer()

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

getChecksum

public abstract long getChecksum()
                          throws java.io.IOException

Returns the current checksum of bytes written so far

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object