Package org.HdrHistogram
Interface ValueRecorder
-
- All Known Implementing Classes:
AbstractHistogram
,AtomicHistogram
,ConcurrentHistogram
,Histogram
,IntCountsHistogram
,PackedConcurrentHistogram
,PackedHistogram
,Recorder
,Recorder.InternalAtomicHistogram
,Recorder.InternalConcurrentHistogram
,Recorder.InternalPackedConcurrentHistogram
,ShortCountsHistogram
,SingleWriterRecorder
,SingleWriterRecorder.InternalHistogram
,SingleWriterRecorder.PackedInternalHistogram
,SynchronizedHistogram
public interface ValueRecorder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
recordValue(long value)
Record a valuevoid
recordValueWithCount(long value, long count)
Record a value (adding to the value's current count)void
recordValueWithExpectedInterval(long value, long expectedIntervalBetweenValueSamples)
Record a value.void
reset()
Reset the contents and collected stats
-
-
-
Method Detail
-
recordValue
void recordValue(long value) throws java.lang.ArrayIndexOutOfBoundsException
Record a value- Parameters:
value
- The value to be recorded- Throws:
java.lang.ArrayIndexOutOfBoundsException
- (may throw) if value cannot be covered by the histogram's range
-
recordValueWithCount
void recordValueWithCount(long value, long count) throws java.lang.ArrayIndexOutOfBoundsException
Record a value (adding to the value's current count)- Parameters:
value
- The value to be recordedcount
- The number of occurrences of this value to record- Throws:
java.lang.ArrayIndexOutOfBoundsException
- (may throw) if value cannot be covered by the histogram's range
-
recordValueWithExpectedInterval
void recordValueWithExpectedInterval(long value, long expectedIntervalBetweenValueSamples) throws java.lang.ArrayIndexOutOfBoundsException
Record a value.To compensate for the loss of sampled values when a recorded value is larger than the expected interval between value samples, will auto-generate an additional series of decreasingly-smaller (down to the expectedIntervalBetweenValueSamples) value records.
Note: This is a at-recording correction method, as opposed to the post-recording correction method provided by
AbstractHistogram.copyCorrectedForCoordinatedOmission(long)
. The two methods are mutually exclusive, and only one of the two should be be used on a given data set to correct for the same coordinated omission issue.- Parameters:
value
- The value to recordexpectedIntervalBetweenValueSamples
- If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples- Throws:
java.lang.ArrayIndexOutOfBoundsException
- (may throw) if value cannot be covered by the histogram's range
-
reset
void reset()
Reset the contents and collected stats
-
-