com.github.rollingmetrics.histogram

Enum OverflowResolver

java.lang.Object

java.lang.Enum<OverflowResolver>

com.github.rollingmetrics.histogram.OverflowResolver

All Implemented Interfaces:

Serializable, Comparable<OverflowResolver>

public enum OverflowResolver
extends Enum<OverflowResolver>

Specifies behavior which should be applied when need to write to reservoir value which greater than highestTrackableValue. When highestTrackableValue is specified then AbstractHistogram may throw ArrayIndexOutOfBoundsException in the method AbstractHistogram.recordValue(long) if value is exceeds highestTrackableValue, so OverflowResolver is addressed to solve this problem.

See Also:

RollingHdrHistogramBuilder.withHighestTrackableValue(long, OverflowResolver), AbstractHistogram.recordValue(long)

Enum Constant Summary

Enum Constants

Enum Constant and Description
PASS_THRU Do not resolve overflow, just passes the value directly to AbstractHistogram.recordValue(long) as result ArrayIndexOutOfBoundsException may be thrown.
REDUCE_TO_HIGHEST_TRACKABLE Resolves overflow by replacing the exceeded value by highestTrackableValue.
SKIP Resolves overflow by skipping value which is exceeds highestTrackableValue, so exceeded value will not be stored.

Method Summary

Modifier and Type	Method and Description
static OverflowResolver	valueOf(String name) Returns the enum constant of this type with the specified name.
static OverflowResolver[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REDUCE_TO_HIGHEST_TRACKABLE

public static final OverflowResolver REDUCE_TO_HIGHEST_TRACKABLE

Resolves overflow by replacing the exceeded value by highestTrackableValue.

SKIP

public static final OverflowResolver SKIP

Resolves overflow by skipping value which is exceeds highestTrackableValue, so exceeded value will not be stored.

PASS_THRU

public static final OverflowResolver PASS_THRU

Do not resolve overflow, just passes the value directly to AbstractHistogram.recordValue(long) as result ArrayIndexOutOfBoundsException may be thrown.

Use this way with double attention iff you clearly understanding what you do.

Method Detail

values

public static OverflowResolver[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OverflowResolver c : OverflowResolver.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OverflowResolver valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null