Package org.apache.flink.runtime.state.heap

Interface HeapPriorityQueueElement

All Known Implementing Classes:

AbstractHeapPriorityQueueElement, SourceCoordinator.WatermarkElement, TimerHeapInternalTimer

@Internal
public interface HeapPriorityQueueElement

Interface for objects that can be managed by a HeapPriorityQueue. Such an object can only be contained in at most one HeapPriorityQueue at a time.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NOT_CONTAINED	The index that indicates that a HeapPriorityQueueElement object is not contained in and managed by any HeapPriorityQueue.

Method Summary

Modifier and Type	Method	Description
int	getInternalIndex()	Returns the current index of this object in the internal array of HeapPriorityQueue.
void	setInternalIndex(int newIndex)	Sets the current index of this object in the HeapPriorityQueue and should only be called by the owning HeapPriorityQueue.

Field Details

NOT_CONTAINED

static final int NOT_CONTAINED

The index that indicates that a HeapPriorityQueueElement object is not contained in and managed by any HeapPriorityQueue. We do not strictly enforce that internal indexes must be reset to this value when elements are removed from a HeapPriorityQueue.

See Also:

• Constant Field Values

Method Details

getInternalIndex

int getInternalIndex()

Returns the current index of this object in the internal array of HeapPriorityQueue.

setInternalIndex

void setInternalIndex(int newIndex)

Sets the current index of this object in the HeapPriorityQueue and should only be called by the owning HeapPriorityQueue.

Parameters:

newIndex - the new index in the timer heap.