Module org.elasticsearch.exponentialhistogram

Package org.elasticsearch.exponentialhistogram

Class CompressedExponentialHistogramHolder

java.lang.Object

org.elasticsearch.exponentialhistogram.CompressedExponentialHistogramHolder

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

public class CompressedExponentialHistogramHolder
extends Object
implements Releasable

Holds an ExponentialHistogram in its encoded form using a circuit-breaking byte buffer for proper memory accounting.

When set to a CompressedExponentialHistogram, the already-encoded bytes are copied directly without re-encoding. For other ExponentialHistogram implementations, the histogram is encoded into the compressed format first.

The stored histogram can be accessed as a ExponentialHistogram via accessor().

Method Summary

Modifier and Type	Method	Description
ExponentialHistogram	accessor()	Provides read access to the histogram this holder stores.
void	close()
static CompressedExponentialHistogramHolder	create(ExponentialHistogramCircuitBreaker breaker)
long	ramBytesUsed()
void	set(ExponentialHistogram incoming)	Sets this holder to a copy of the given histogram.

Methods inherited from class java.lang.Object

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

Method Details

create

public static CompressedExponentialHistogramHolder create(ExponentialHistogramCircuitBreaker breaker)

set

public void set(ExponentialHistogram incoming)

Sets this holder to a copy of the given histogram.

accessor

public ExponentialHistogram accessor()

Provides read access to the histogram this holder stores.

ramBytesUsed

public long ramBytesUsed()

Returns:

the estimated RAM usage of this holder including the encoded buffer.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable