Package org.HdrHistogram

Class EncodableHistogram

java.lang.Object
org.HdrHistogram.EncodableHistogram
Direct Known Subclasses:
AbstractHistogramBase, DoubleHistogram
public abstract class EncodableHistogram extends Object
A base class for all encodable (and decodable) histogram classes. Log readers and writers will generally use this base class to provide common log processing across the integer value based AbstractHistogram subclasses and the double value based DoubleHistogram class.

  • Constructor Details

    • EncodableHistogram

      public EncodableHistogram()

  • Method Details

    • getNeededByteBufferCapacity

      public abstract int getNeededByteBufferCapacity()

    • encodeIntoCompressedByteBuffer

      public abstract int encodeIntoCompressedByteBuffer(ByteBuffer targetBuffer, int compressionLevel)

    • getStartTimeStamp

      public abstract long getStartTimeStamp()

    • setStartTimeStamp

      public abstract void setStartTimeStamp(long startTimeStamp)

    • getEndTimeStamp

      public abstract long getEndTimeStamp()

    • setEndTimeStamp

      public abstract void setEndTimeStamp(long endTimestamp)

    • getTag

      public abstract String getTag()

    • setTag

      public abstract void setTag(String tag)

    • getMaxValueAsDouble

      public abstract double getMaxValueAsDouble()

    • decodeFromCompressedByteBuffer

      static EncodableHistogram decodeFromCompressedByteBuffer(ByteBuffer buffer, long minBarForHighestTrackableValue) throws DataFormatException
      Decode a EncodableHistogram from a compressed byte buffer. Will return either a Histogram or DoubleHistogram depending on the format found in the supplied buffer.
      Parameters:
      buffer - The input buffer to decode from.
      minBarForHighestTrackableValue - A lower bound either on the highestTrackableValue of the created Histogram, or on the HighestToLowestValueRatio of the created DoubleHistogram.
      Returns:
      The decoded Histogram or DoubleHistogram
      Throws:
      DataFormatException - on errors in decoding the buffer compression.