AbstractHeapPriorityQueue (Flink : Runtime 1.17.1 API)

java.lang.Object
- org.apache.flink.runtime.state.heap.AbstractHeapPriorityQueue<T>

类型参数:

T - type of the elements contained in the priority queue.

所有已实现的接口:

InternalPriorityQueue<T>

直接已知子类:

HeapPriorityQueue
```
public abstract class AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>
extends Object
implements InternalPriorityQueue<T>
```
Abstract base class for heap (object array) based implementations of priority queues, with support for fast deletes via HeapPriorityQueueElement.

字段概要

字段
限定符和类型字段和说明

protected T[] queue
The array that represents the heap-organized priority queue.

protected int size
The current size of the priority queue.

字段
限定符和类型	字段和说明
`protected T[]`	`queue` The array that represents the heap-organized priority queue.
`protected int`	`size` The current size of the priority queue.

构造器概要

构造器
构造器和说明

AbstractHeapPriorityQueue(int minimumCapacity)

构造器
构造器和说明
`AbstractHeapPriorityQueue(int minimumCapacity)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`boolean`	`add(T toAdd)` Adds the given element to the set, if it is not already contained.
`void`	`addAll(Collection<? extends T> toAdd)` Adds all the given elements to the set.
`protected abstract void`	`addInternal(T toAdd)` Implements how to add an element to the queue.
`void`	`clear()` Clears the queue.
`protected abstract int`	`getHeadElementIndex()` Returns the start index of the queue elements in the array.
`boolean`	`isEmpty()` Check if the set contains any elements.
`org.apache.flink.util.CloseableIterator<T>`	`iterator()` Returns an iterator over the elements in this queue.
`protected void`	`moveElementToIdx(T element, int idx)`
`T`	`peek()` Retrieves, but does not remove, the element (w.r.t. order) of this set, or returns `null` if this set is empty.
`T`	`poll()` Retrieves and removes the first element (w.r.t. the order) of this set, or returns `null` if this set is empty.
`boolean`	`remove(T toRemove)` Removes the given element from the set, if is contained in the set.
`protected abstract T`	`removeInternal(int elementIndex)` Implements how to remove the element at the given index from the queue.
`protected void`	`resizeForBulkLoad(int totalSize)`
`protected void`	`resizeQueueArray(int desiredSize, int minRequiredSize)`
`int`	`size()` Returns the number of elements in this set.
`<O> O[]`	`toArray(O[] out)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - queue
```
@Nonnull
protected T extends HeapPriorityQueueElement[] queue
```
    The array that represents the heap-organized priority queue.
  - size
```
@Nonnegative
protected int size
```
    The current size of the priority queue.
- 构造器详细资料
  - AbstractHeapPriorityQueue
```
public AbstractHeapPriorityQueue(@Nonnegative
                                 int minimumCapacity)
```
- 方法详细资料
  - poll
```
@Nullable
public T poll()
```
    从接口复制的说明: InternalPriorityQueue
    
    Retrieves and removes the first element (w.r.t. the order) of this set, or returns null if this set is empty.
    NOTE: Correct key (i.e. the key of the polled element) must be set on KeyContext before calling this method.
    
    指定者:
    
    poll 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    返回:
    
    the first element of this ordered set, or null if this set is empty.
  - peek
```
@Nullable
public T peek()
```
    从接口复制的说明: InternalPriorityQueue
    
    Retrieves, but does not remove, the element (w.r.t. order) of this set, or returns null if this set is empty.
    
    指定者:
    
    peek 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    返回:
    
    the first element (w.r.t. order) of this ordered set, or null if this set is empty.
  - add
```
public boolean add(@Nonnull
                   T toAdd)
```
    从接口复制的说明: InternalPriorityQueue
    
    Adds the given element to the set, if it is not already contained.
    
    指定者:
    
    add 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    参数:
    
    toAdd - the element to add to the set.
    
    返回:
    
    true if the operation changed the head element or if it is unclear if the head element changed. Only returns false if the head element was not changed by this operation.
  - remove
```
public boolean remove(@Nonnull
                      T toRemove)
```
    从接口复制的说明: InternalPriorityQueue
    
    Removes the given element from the set, if is contained in the set.
    NOTE: Correct key (i.e. the key of the polled element) must be set on KeyContext before calling this method.
    
    指定者:
    
    remove 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    参数:
    
    toRemove - the element to remove.
    
    返回:
    
    true if the operation changed the head element or if it is unclear if the head element changed. Only returns false if the head element was not changed by this operation.
  - isEmpty
```
public boolean isEmpty()
```
    从接口复制的说明: InternalPriorityQueue
    
    Check if the set contains any elements.
    
    指定者:
    
    isEmpty 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    返回:
    
    true if the set is empty, i.e. no element is contained.
  - size
```
public int size()
```
    从接口复制的说明: InternalPriorityQueue
    
    Returns the number of elements in this set.
    
    指定者:
    
    size 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    返回:
    
    the number of elements in this set.
  - addAll
```
public void addAll(@Nullable
                   Collection<? extends T> toAdd)
```
    从接口复制的说明: InternalPriorityQueue
    
    Adds all the given elements to the set.
    
    指定者:
    
    addAll 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
  - toArray
```
@Nonnull
public <O> O[] toArray(O[] out)
```
  - iterator
```
@Nonnull
public org.apache.flink.util.CloseableIterator<T> iterator()
```
    Returns an iterator over the elements in this queue. The iterator does not return the elements in any particular order.
    
    指定者:
    
    iterator 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>
    
    返回:
    
    an iterator over the elements in this queue.
  - clear
```
public void clear()
```
    Clears the queue.
  - resizeForBulkLoad
```
protected void resizeForBulkLoad(int totalSize)
```
  - resizeQueueArray
```
protected void resizeQueueArray(int desiredSize,
                                int minRequiredSize)
```
  - moveElementToIdx
```
protected void moveElementToIdx(T element,
                                int idx)
```
  - removeInternal
```
protected abstract T removeInternal(@Nonnegative
                                    int elementIndex)
```
    Implements how to remove the element at the given index from the queue.
    
    参数:
    
    elementIndex - the index to remove.
    
    返回:
    
    the removed element.
  - addInternal
```
protected abstract void addInternal(@Nonnull
                                    T toAdd)
```
    Implements how to add an element to the queue.
    
    参数:
    
    toAdd - the element to add.
  - getHeadElementIndex
```
protected abstract int getHeadElementIndex()
```
    Returns the start index of the queue elements in the array.

类 AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

queue

size

构造器详细资料

AbstractHeapPriorityQueue

方法详细资料

poll

peek

add

remove

isEmpty

size

addAll

toArray

iterator

clear

resizeForBulkLoad

resizeQueueArray

moveElementToIdx

removeInternal

addInternal

getHeadElementIndex