org.apache.druid.segment.writeout

Interface SegmentWriteOutMedium

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

OffHeapMemorySegmentWriteOutMedium, OnHeapMemorySegmentWriteOutMedium, TmpFileSegmentWriteOutMedium

public interface SegmentWriteOutMedium
extends Closeable

SegmentWriteOutMedium is an umbrella "resource disposer" for temporary buffers (in the form of WriteOutBytes, obtained by calling makeWriteOutBytes() on the SegmentWriteOutMedium instance), that are used during new Druid segment creation, and other resources (see getCloser()). When SegmentWriteOutMedium is closed, all child WriteOutBytes couldn't be used anymore.

Method Summary

Modifier and Type	Method and Description
Closer	getCloser() Returns a closer of this SegmentWriteOutMedium, which is closed in this SegmentWriteOutMedium's close() method.
WriteOutBytes	makeWriteOutBytes() Creates a new empty WriteOutBytes, attached to this SegmentWriteOutMedium.

Methods inherited from interface java.io.Closeable

close

Method Detail

makeWriteOutBytes

WriteOutBytes makeWriteOutBytes()
                         throws IOException

Creates a new empty WriteOutBytes, attached to this SegmentWriteOutMedium. When this SegmentWriteOutMedium is closed, the returned WriteOutBytes couldn't be used anymore.

Throws:

IOException

getCloser

Closer getCloser()

Returns a closer of this SegmentWriteOutMedium, which is closed in this SegmentWriteOutMedium's close() method. Could be used to "attach" some random resources to this SegmentWriteOutMedium, to be closed at the same time.