org.apache.datasketches.theta

Enum UpdateReturnState

java.lang.Object

java.lang.Enum<UpdateReturnState>

org.apache.datasketches.theta.UpdateReturnState

All Implemented Interfaces:

Serializable, Comparable<UpdateReturnState>

public enum UpdateReturnState
extends Enum<UpdateReturnState>

See Update Return State

Author:

Lee Rhodes

Enum Constant Summary

Enum Constants

Enum Constant and Description
ConcurrentBufferInserted Indicates that the value was inserted into the local concurrent buffer, but has not yet been propagated to the concurrent shared sketch.
ConcurrentPropagated Indicates that the value has been propagated to the concurrent shared sketch.
InsertedCountIncremented Indicates that the value was accepted into the sketch and the retained count was incremented.
InsertedCountNotIncremented Indicates that the value was accepted into the sketch and the retained count was not incremented.
RejectedDuplicate Indicates that the value was rejected as a duplicate.
RejectedNullOrEmpty Indicates that the value was rejected because it was null or empty.
RejectedOverTheta Indicates that the value was rejected because the hash value was negative, zero or greater than theta.

Method Summary

Modifier and Type	Method and Description
static UpdateReturnState	valueOf(String name) Returns the enum constant of this type with the specified name.
static UpdateReturnState[]	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

InsertedCountIncremented

public static final UpdateReturnState InsertedCountIncremented

Indicates that the value was accepted into the sketch and the retained count was incremented.

InsertedCountNotIncremented

public static final UpdateReturnState InsertedCountNotIncremented

Indicates that the value was accepted into the sketch and the retained count was not incremented.

ConcurrentBufferInserted

public static final UpdateReturnState ConcurrentBufferInserted

Indicates that the value was inserted into the local concurrent buffer, but has not yet been propagated to the concurrent shared sketch.

ConcurrentPropagated

public static final UpdateReturnState ConcurrentPropagated

Indicates that the value has been propagated to the concurrent shared sketch. This does not reflect the action taken by the shared sketch.

RejectedDuplicate

public static final UpdateReturnState RejectedDuplicate

Indicates that the value was rejected as a duplicate.

RejectedNullOrEmpty

public static final UpdateReturnState RejectedNullOrEmpty

Indicates that the value was rejected because it was null or empty.

RejectedOverTheta

public static final UpdateReturnState RejectedOverTheta

Indicates that the value was rejected because the hash value was negative, zero or greater than theta.

Method Detail

values

public static UpdateReturnState[] 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 (UpdateReturnState c : UpdateReturnState.values())
    System.out.println(c);

Returns:

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

valueOf

public static UpdateReturnState 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