HdrHistogram 2.1.12 · org.HdrHistogram.ValueRecorder

Method Summary

Modifier and Type	Method and Description
public void	recordValue(long The value to be recorded value) Record a value
public void	recordValueWithCount(long The value to be recorded value, long The number of occurrences of this value to record count) Record a value (adding to the value's current count)
public void	recordValueWithExpectedInterval(long The value to record value, long If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples expectedIntervalBetweenValueSamples) Record a value.
public void	reset() Reset the contents and collected stats

Method Detail

recordValue	back to summary
public void recordValue(long value) throws ArrayIndexOutOfBoundsException Record a value Parameters value:long The value to be recorded Exceptions ArrayIndexOutOfBoundsException: (may throw) if value cannot be covered by the histogram's range

recordValue

back to summary

public void recordValue(long value) throws ArrayIndexOutOfBoundsException

Record a value

Parameters

value:long: The value to be recorded

Exceptions

ArrayIndexOutOfBoundsException:: (may throw) if value cannot be covered by the histogram's range

recordValueWithCount	back to summary
public void recordValueWithCount(long value, long count) throws ArrayIndexOutOfBoundsException Record a value (adding to the value's current count) Parameters value:long The value to be recorded count:long The number of occurrences of this value to record Exceptions ArrayIndexOutOfBoundsException: (may throw) if value cannot be covered by the histogram's range

recordValueWithCount

back to summary

public void recordValueWithCount(long value, long count) throws ArrayIndexOutOfBoundsException

Record a value (adding to the value's current count)

Parameters

value:long: The value to be recorded
count:long: The number of occurrences of this value to record

Exceptions

ArrayIndexOutOfBoundsException:: (may throw) if value cannot be covered by the histogram's range

recordValueWithExpectedInterval back to summary

recordValueWithExpectedInterval	back to summary
public void recordValueWithExpectedInterval(long value, long expectedIntervalBetweenValueSamples) throws 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:long The value to record expectedIntervalBetweenValueSamples:long If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples Exceptions ArrayIndexOutOfBoundsException: (may throw) if value cannot be covered by the histogram's range

public void recordValueWithExpectedInterval(long value, long expectedIntervalBetweenValueSamples) throws 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:long: The value to record
expectedIntervalBetweenValueSamples:long: If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples

Exceptions

ArrayIndexOutOfBoundsException:: (may throw) if value cannot be covered by the histogram's range

reset	back to summary
public void reset() Reset the contents and collected stats

public Interface ValueRecorder

Method Summary

Method Detail