Package org.elasticsearch.common.bytes

Class ReleasablePagedBytesReference

java.lang.Object

org.elasticsearch.common.bytes.BytesReference

org.elasticsearch.common.bytes.PagedBytesReference

org.elasticsearch.common.bytes.ReleasablePagedBytesReference

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<BytesReference>, org.apache.lucene.util.Accountable, Releasable, ToXContent, ToXContentFragment

public final class ReleasablePagedBytesReference
extends PagedBytesReference
implements Releasable

An extension to PagedBytesReference that requires releasing its content. This class exists to make it explicit when a bytes reference needs to be released, and when not.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.bytes.PagedBytesReference

byteArray

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ReleasablePagedBytesReference(BigArrays bigarrays, ByteArray byteArray, int length, Releasable releasable)

Method Summary

Modifier and Type	Method	Description
void	close()

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Methods inherited from class org.elasticsearch.common.bytes.BytesReference

bytes, compareTo, equals, hashCode, streamInput, toBytes, toXContent, utf8ToString, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.common.bytes.PagedBytesReference

get, iterator, length, ramBytesUsed, slice, toBytesRef

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Detail

ReleasablePagedBytesReference

public ReleasablePagedBytesReference(BigArrays bigarrays,
                                     ByteArray byteArray,
                                     int length,
                                     Releasable releasable)

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable