Package org.apache.lucene.store
Class FilterIndexOutput
java.lang.Object
org.apache.lucene.store.DataOutput
org.apache.lucene.store.IndexOutput
org.apache.lucene.store.FilterIndexOutput
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
RateLimitedIndexOutput
IndexOutput implementation that delegates calls to another directory. This class can be used to
add limitations on top of an existing
IndexOutput implementation such as ByteBuffersIndexOutput or to add additional sanity checks for tests. However, if you plan to
write your own IndexOutput implementation, you should consider extending directly IndexOutput or DataOutput rather than try to reuse functionality of existing IndexOutputs by extending this class.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFilterIndexOutput(String resourceDescription, String name, IndexOutput out) Creates a FilterIndexOutput with a resource description, name, and wrapped delegate IndexOutput -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes this stream to further operations.longReturns the current checksum of bytes written so farfinal IndexOutputGets the delegate that was passed in on creationlongReturns the current position in this file, where the next write will occur.static IndexOutputunwrap(IndexOutput out) Unwraps all FilterIndexOutputs until the first non-FilterIndexOutput IndexOutput instance and returns itvoidwriteByte(byte b) Writes a single byte.voidwriteBytes(byte[] b, int offset, int length) Writes an array of bytes.Methods inherited from class org.apache.lucene.store.IndexOutput
alignFilePointer, alignOffset, getName, toStringMethods inherited from class org.apache.lucene.store.DataOutput
copyBytes, writeBytes, writeGroupVInts, writeGroupVInts, writeInt, writeLong, writeMapOfStrings, writeSetOfStrings, writeShort, writeString, writeVInt, writeVLong, writeZInt, writeZLong
-
Field Details
-
out
-
-
Constructor Details
-
FilterIndexOutput
Creates a FilterIndexOutput with a resource description, name, and wrapped delegate IndexOutput
-
-
Method Details
-
unwrap
Unwraps all FilterIndexOutputs until the first non-FilterIndexOutput IndexOutput instance and returns it -
getDelegate
Gets the delegate that was passed in on creation -
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:
-