AbstractQueue

发表于 更新于 分类于 ， ， ，

概述

AbstractQueue提供一些Queue操作的基本实现。其中方法add，remove和element分别基于offer，poll和peek实现（需要子类自己实现），默认是抛出异常而不是通过false或null返回指示失败。

方法定义

1
2
3
4
5
public abstract class AbstractQueue<E>
    extends AbstractCollection<E>
    implements Queue<E> {
 ......   
}

AbstractQueue定义如上图所示，继承了AbstractCollection提供基本的“收集元素”功能，实现Queue接口，仅仅实现了add，remove和element这三个方法的基本的实现

boolean add(E e)

1
2
3
4
5
6
public boolean add(E e) {
    if (offer(e))
        return true;
    else
        throw new IllegalStateException("Queue full");
}

add方法是基于offer方法来实现的，其中offer方法需要子类来实现，如果offer方法返回false的话说明此时队列以及满了，那么则直接抛出异常，这和Queue中add方法的定义保持一致。

E element()

1
2
3
4
5
6
7
public E element() {
    E x = peek();
    if (x != null)
        return x;
    else
        throw new NoSuchElementException();
}

element方法是基于peek方法来实现的，其中peek方法需要子类来实现，如果peek方法返回null说明此时队列为空，那么则直接抛出异常，这和Queue中element方法的定义保持一致。

E remove()

1
2
3
4
5
6
7
public E remove() {
    E x = poll();
    if (x != null)
        return x;
    else
        throw new NoSuchElementException();
}

remove方法是基于poll方法来实现的，其中poll方法需要子类来实现，如果poll方法返回null说明此时队列为空，那么则直接抛出异常，这和Queue中remove方法的定义保持一致。

void clear()

1
2
3
4
public void clear() {
    while (poll() != null)
        ;
}

clear方法的作用是清空队列中的所有元素，是基于poll方法来实现的，其中poll方法需要子类来实现，如果poll方法返回null说明此时队列为空，因此通过while循环调用poll方法直到队列为空为止。

boolean addAll(Collection<? extends E> c)

1
2
3
4
5
6
7
8
9
10
11
public boolean addAll(Collection<? extends E> c) {
    if (c == null)
        throw new NullPointerException();
    if (c == this)
        throw new IllegalArgumentException();
    boolean modified = false;
    for (E e : c)
        if (add(e))
            modified = true;
    return modified;
}

addAll方法的作用是将指定Collection中的元素通过迭代的方式全部添加到当前队列中，需要注意的是addAll方法是基于boolean add(E e)方法来实现的，AbstractQueue内部默认的add方法实现实在队列已满时会抛出IllegalStateException