CopyOnWriteArrayList

import sun.misc.SharedSecrets;

import java.util.*;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.UnaryOperator;

/**
 * A thread-safe variant of {@link ArrayList} in which all mutative
 * operations ({@code add}, {@code set}, and so on) are implemented by
 * making a fresh copy of the underlying array.
 * 这是一个ArrayList的线程安全的变体类,在所有可以引起内部数据变化的操作中都会存在一个潜在的拷贝操作,如add()、set()等
 *
 * <p>This is ordinarily too costly, but may be <em>more</em> efficient
 * than alternatives when traversal operations vastly outnumber
 * mutations, and is useful when you cannot or don't want to
 * synchronize traversals, yet need to preclude interference among
 * concurrent threads.  The "snapshot" style iterator method uses a
 * reference to the state of the array at the point that the iterator
 * was created. This array never changes during the lifetime of the
 * iterator, so interference is impossible and the iterator is
 * guaranteed not to throw {@code ConcurrentModificationException}.
 * The iterator will not reflect additions, removals, or changes to
 * the list since the iterator was created.  Element-changing
 * operations on iterators themselves ({@code remove}, {@code set}, and
 * {@code add}) are not supported. These methods throw
 * {@code UnsupportedOperationException}.
 * 这通常成本太高,但当遍历操作大大超过突变时可能比替代方法更有效,
 * 并且当您不能或不想同步遍历时很有用,但需要排除并发线程之间的干扰。
 * “快照”样式的迭代器方法使用对创建迭代器时数组状态的引用。
 * 这个数组在迭代器的生命周期内永远不会改变,所以干扰是不可能的,
 * 并且迭代器保证不会抛出ConcurrentModificationException 。
 * 自创建迭代器以来,迭代器不会反映对列表的添加、删除或更改。 不支持迭代器本身的元素更改操作( remove 、 set和add )。
 * 这些方法抛出UnsupportedOperationException 。
 *
 * <p>All elements are permitted, including {@code null}.
 * 允许所有元素,包括null 。
 *
 * <p>Memory consistency effects: As with other concurrent
 * collections, actions in a thread prior to placing an object into a
 * {@code CopyOnWriteArrayList}
 * <a href="package-summary.html#MemoryVisibility"><i>happen-before</i></a>
 * actions subsequent to the access or removal of that element from
 * the {@code CopyOnWriteArrayList} in another thread.
 * 内存一致性影响:与其他并发集合一样,
 * 在将对象放入CopyOnWriteArrayList之前线程中的操作
 * 发生在另一个线程中从CopyOnWriteArrayList访问或删除该元素之后的操作之前。
 *
 * <p>This class is a member of the
 * <a href="{@docRoot}/../technotes/guides/collections/index.html">
 * Java Collections Framework</a>.
 *
 * @param <E> the type of elements held in this collection
 * @author Doug Lea
 * @since 1.5
 */
public class CopyOnWriteArrayList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    private static final long serialVersionUID = 8673264195747942595L;

    /** The lock protecting all mutators */
    /**
     * 保护所有突变器的锁
     */
    final transient ReentrantLock lock = new ReentrantLock();

    /** The array, accessed only via getArray/setArray. */
    /**
     * 数组,仅通过getArray/setArray访问。
     */
    private transient volatile Object[] array;

    /**
     * Gets the array.  Non-private so as to also be accessible
     * from CopyOnWriteArraySet class.
     * 设置为非private,方便CopyOnWriteArraySet类使用
     */
    final Object[] getArray() {
        return array;
    }

    /**
     * Sets the array.
     * set内部数组
     */
    final void setArray(Object[] a) {
        array = a;
    }

    /**
     * Creates an empty list.
     * 创建一个空的列表
     */
    public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }

    /**
     * Creates a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     * 创建一个包含传入集合的列表,可以很方便的返回这个集合的迭代器
     *
     * @param c the collection of initially held elements 需要传入的初始化集合
     * @throws NullPointerException if the specified collection is null 该初始化集合不能为空
     */
    public CopyOnWriteArrayList(Collection<? extends E> c) {
        Object[] elements;
        if (c.getClass() == CopyOnWriteArrayList.class)
            // 如果是传入的初始化集合是CopyOnWriteArrayList类则使用内部的getArray()获取内部数组
            // 由于CopyOnWriteArrayList内部的ToArray()需要一次拷贝,相对getArray()效率较低
            elements = ((CopyOnWriteArrayList<?>) c).getArray();
        else {
            // 如果是其它的Collection实现类,直接调用对应的toArray()
            elements = c.toArray();

            // 如果也不是ArrayList类,则对这份数据进行拷贝
            if (c.getClass() != ArrayList.class)
                elements = Arrays.copyOf(elements, elements.length, Object[].class);
        }

        // 设置内部数组
        setArray(elements);
    }

    /**
     * Creates a list holding a copy of the given array.
     * 创建一个拥有所给数组拷贝的列表
     *
     * @param toCopyIn the array (a copy of this array is used as the
     *                 internal array)
     *                 所给的数组不会被直接使用,而是会被拷贝一份来使用作为内部数组
     * @throws NullPointerException if the specified array is null 所给数组不能为空
     */
    public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
    }

    /**
     * Returns the number of elements in this list.
     * 返回列表元素的数量
     *
     * @return the number of elements in this list
     */
    public int size() {
        return getArray().length;
    }

    /**
     * Returns {@code true} if this list contains no elements.
     * 返回当前链表是否有元素
     *
     * @return {@code true} if this list contains no elements
     */
    public boolean isEmpty() {
        return size() == 0;
    }

    /**
     * Tests for equality, coping with nulls.
     * 判断两个对象是否相等
     * 如果o1为null
     * 判断o2是否为null
     * 如果是 返回 true
     * 不是   返回 false
     * 如果o1不为null
     * 直接调用o1的equal方法判断
     */
    private static boolean eq(Object o1, Object o2) {
        return (o1 == null) ? o2 == null : o1.equals(o2);
    }

    /**
     * static version of indexOf, to allow repeated calls without
     * needing to re-acquire array each time.
     * static版本的indexOf, 这样的实现可以做到不用直接获取内部数组
     *
     * @param o        element to search for 需要找到的 目标元素
     * @param elements the array 被查找的数组
     * @param index    first index to search 起始位置
     * @param fence    one past last index to search 边界,搜索时到只搜索这个位置前面的元素
     * @return index of element, or -1 if absent
     * 第一个被找到的 目标元素 在 被查找数组 中的位置(从左到右) 或者当未找到时 目标元素时返回 -1
     */
    private static int indexOf(Object o, Object[] elements,
                               int index, int fence) {
        if (o == null) {
            // 寻找元素为null的位置
            for (int i = index; i < fence; i++)
                // 是否相等
                if (elements[i] == null)
                    return i;
        } else {
            for (int i = index; i < fence; i++)
                // 调用equals去判断是否相等
                if (o.equals(elements[i]))
                    return i;
        }

        // 未找到直接返回-1
        return -1;
    }

    /**
     * static version of lastIndexOf.
     * 与上面的IndexOf()相反,这个方法获取 目标元素中最后一个被找到的 目标元素
     *
     * @param o        element to search for 需要找到的 目标元素
     * @param elements the array 被查找的数组
     * @param index    first index to search 起始位置
     * @return index of element, or -1 if absent
     * 第一个被找到的 目标元素 在 被查找数组 中的位置(从右到左) 或者当未找到时 目标元素时返回 -1
     */
    private static int lastIndexOf(Object o, Object[] elements, int index) {
        if (o == null) {
            // 寻找元素为null的位置
            for (int i = index; i >= 0; i--)
                // 是否相等
                if (elements[i] == null)
                    return i;
        } else {
            for (int i = index; i >= 0; i--)
                // 调用equals去判断是否相等
                if (o.equals(elements[i]))
                    return i;
        }

        // 未找到直接返回-1
        return -1;
    }

    /**
     * Returns {@code true} if this list contains the specified element.
     * More formally, returns {@code true} if and only if this list contains
     * at least one element {@code e} such that
     * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>.
     * 判断 目标元素 是否至少在 内部数组 中存在一个
     *
     * @param o element whose presence in this list is to be tested
     *          需要在 内部数组 中被查找的 目标元素
     * @return {@code true} if this list contains the specified element
     */
    public boolean contains(Object o) {
        // 获取内部数组,且获取的elements不会变化(通过下面的相关修改方法可以看出)
        Object[] elements = getArray();

        // 如果返回大于等于0则说明至少存在一个元素,否则不存在该元素
        return indexOf(o, elements, 0, elements.length) >= 0;
    }

    /**
     * {@inheritDoc}
     * 实现List接口中的方法
     */
    public int indexOf(Object o) {
        Object[] elements = getArray();
        return indexOf(o, elements, 0, elements.length);
    }

    /**
     * Returns the index of the first occurrence of the specified element in
     * this list, searching forwards from {@code index}, or returns -1 if
     * the element is not found.
     * More formally, returns the lowest index {@code i} such that
     * <tt>(i&nbsp;&gt;=&nbsp;index&nbsp;&amp;&amp;&nbsp;(e==null&nbsp;?&nbsp;get(i)==null&nbsp;:&nbsp;e.equals(get(i))))</tt>,
     * or -1 if there is no such index.
     * 获取 内部数组的指定位置(index)以后的元素中是否存在(从左到右) 目标元素, 如果存在返回第一个找到的位置
     *
     * @param e     element to search for
     * @param index index to start searching from 搜索的开始位置
     * @return the index of the first occurrence of the element in
     * this list at position {@code index} or later in the list;
     * 如果找到返回对应的位置
     * {@code -1} if the element is not found.
     * 否则返回-1
     * @throws IndexOutOfBoundsException if the specified index is negative
     *                                   开始位置(index)不能为负数
     */
    public int indexOf(E e, int index) {
        Object[] elements = getArray();
        return indexOf(e, elements, index, elements.length);
    }

    /**
     * {@inheritDoc}
     * 实现List接口中的方法
     */
    public int lastIndexOf(Object o) {
        Object[] elements = getArray();
        return lastIndexOf(o, elements, elements.length - 1);
    }

    /**
     * Returns the index of the last occurrence of the specified element in
     * this list, searching backwards from {@code index}, or returns -1 if
     * the element is not found.
     * More formally, returns the highest index {@code i} such that
     * <tt>(i&nbsp;&lt;=&nbsp;index&nbsp;&amp;&amp;&nbsp;(e==null&nbsp;?&nbsp;get(i)==null&nbsp;:&nbsp;e.equals(get(i))))</tt>,
     * or -1 if there is no such index.
     * 获取 内部数组的指定位置(index)以后的元素中是否存在(从右到左) 目标元素,如果存在返回第一个找到的元素位置
     *
     * @param e     element to search for
     * @param index index to start searching backwards from
     * @return the index of the last occurrence of the element at position
     * less than or equal to {@code index} in this list;
     * 如果找到返回对应的位置
     * -1 if the element is not found.
     * 否则返回-1
     * @throws IndexOutOfBoundsException if the specified index is greater
     *                                   than or equal to the current size of this list
     *                                   index必须小于超出数组长度
     */
    public int lastIndexOf(E e, int index) {
        Object[] elements = getArray();
        return lastIndexOf(e, elements, index);
    }

    /**
     * Returns a shallow copy of this list.  (The elements themselves
     * are not copied.)
     * 返回这个数组的浅拷贝
     *
     * @return a clone of this list
     */
    public Object clone() {
        try {
            // 克隆元素
            @SuppressWarnings("unchecked")
            CopyOnWriteArrayList<E> clone =
                    (CopyOnWriteArrayList<E>) super.clone();

            // TODO
            clone.resetLock();

            // 返回
            return clone;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            // 自从我们有了Cloneable接口以后,一般不会抛出这个异常
            throw new InternalError();
        }
    }

    /**
     * Returns an array containing all of the elements in this list
     * in proper sequence (from first to last element).
     * 返回一个包含当前内部数组所有元素的列表
     * <p>The returned array will be "safe" in that no references to it are
     * maintained by this list.  (In other words, this method must allocate
     * a new array).  The caller is thus free to modify the returned array.
     * 返回的数组是安全的,没有引用回去修改它,因为返回的是一个拷贝的新数组
     * <p>This method acts as bridge between array-based and collection-based
     * APIs.
     * 这个方法可以充当集合和数组之间的桥梁
     *
     * @return an array containing all the elements in this list
     */
    public Object[] toArray() {
        Object[] elements = getArray();

        // 拷贝 内部数组 并返回
        return Arrays.copyOf(elements, elements.length);
    }

    /**
     * Returns an array containing all of the elements in this list in
     * proper sequence (from first to last element); the runtime type of
     * the returned array is that of the specified array.  If the list fits
     * in the specified array, it is returned therein.  Otherwise, a new
     * array is allocated with the runtime type of the specified array and
     * the size of this list.
     * 返回一个包含 内部数组 中所有元素的 数组,返回数组的类型与传进来数组的类型一样(编译器可以保证),
     * 如果传进来的数组可以容纳所有的内部数组元素,则最后返回传进来的数组,否则返回一个新生成的数组
     *
     * <p>If this list fits in the specified array with room to spare
     * (i.e., the array has more elements than this list), the element in
     * the array immediately following the end of the list is set to
     * {@code null}.  (This is useful in determining the length of this
     * list <i>only</i> if the caller knows that this list does not contain
     * any null elements.)
     *
     *
     * <p>Like the {@link #toArray()} method, this method acts as bridge between
     * array-based and collection-based APIs.  Further, this method allows
     * precise control over the runtime type of the output array, and may,
     * under certain circumstances, be used to save allocation costs.
     *
     * <p>Suppose {@code x} is a list known to contain only strings.
     * The following code can be used to dump the list into a newly
     * allocated array of {@code String}:
     *
     * <pre> {@code String[] y = x.toArray(new String[0]);}</pre>
     * <p>
     * Note that {@code toArray(new Object[0])} is identical in function to
     * {@code toArray()}.
     *
     * @param a the array into which the elements of the list are to
     *          be stored, if it is big enough; otherwise, a new array of the
     *          same runtime type is allocated for this purpose.
     * @return an array containing all the elements in this list
     * @throws ArrayStoreException  if the runtime type of the specified array
     *                              is not a supertype of the runtime type of every element in
     *                              this list
     * @throws NullPointerException if the specified array is null
     */
    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T a[]) {
        Object[] elements = getArray();
        int len = elements.length;
        if (a.length < len)
            // 1.当 内部数组 的长度大于 传进来的数组长度时,直接将内部数组的所有元素复制到一个新的数组中并且返回
            return (T[]) Arrays.copyOf(elements, len, a.getClass());
        else {
            // 2.当 内部数组 的长度小于等于 传进来的数组长度时,将 内部数组 中的元素复制到传进来的数组中,并且返回该数组
            System.arraycopy(elements, 0, a, 0, len);

            // 如果a的实际长度大于 内部数组,则将最后一位赋值为null
            if (a.length > len)
                a[len] = null;

            // 返回结果
            return a;
        }
    }

    // Positional Access Operations
    // 直接获取对应位置的元素
    @SuppressWarnings("unchecked")
    private E get(Object[] a, int index) {
        return (E) a[index];
    }

    /**
     * {@inheritDoc}
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     *                                   实现List接口
     */
    public E get(int index) {
        return get(getArray(), index);
    }

    /**
     * Replaces the element at the specified position in this list with the specified element.
     * 设置特定位置的元素值
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E set(int index, E element) {
        // 获取锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            E oldValue = get(elements, index);

            if (oldValue != element) {
                // 插入值与原值
                int len = elements.length;
                Object[] newElements = Arrays.copyOf(elements, len);
                newElements[index] = element;
                setArray(newElements);
            } else {
                // Not quite a no-op; ensures volatile write semantics
                setArray(elements);
            }
            return oldValue;
        } finally {
            lock.unlock();
        }
    }

    /**
     * Appends the specified element to the end of this list.
     * 将元素追加到列表末尾
     * Collection接口的实现方法
     *
     * @param e element to be appended to this list 需要追加的元素
     * @return {@code true 追加成功返回true;失败返回false} (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        // 上锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 获取当前数组
            Object[] elements = getArray();
            // 当前数组长度
            int len = elements.length;

            // 获取一个长度为len + 1的数组
            Object[] newElements = Arrays.copyOf(elements, len + 1);

            // 将e 放入最后一个位置
            newElements[len] = e;

            // 更新数组
            setArray(newElements);

            // 返回追加成功
            return true;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Inserts the specified element at the specified position in this
     * list. Shifts the element currently at that position (if any) and
     * any subsequent elements to the right (adds one to their indices).
     * 将元素插入特定的位置,将指定位置后的所有元素向右移动
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public void add(int index, E element) {
        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 获取当前数组信息
            Object[] elements = getArray();
            int len = elements.length;

            // 如果当前的位置超过范围则直接抛出错误
            if (index > len || index < 0)
                throw new IndexOutOfBoundsException("Index: " + index +
                        ", Size: " + len);

            Object[] newElements;

            // 计算数组右边需要移动多少个元素
            int numMoved = len - index;


            if (numMoved == 0)
                // 如果不需要移动任何元素,则类似直接调用add()
                newElements = Arrays.copyOf(elements, len + 1);
            else {
                // 创建长度为len + 1的数组
                newElements = new Object[len + 1];

                // 先将原数组中[0,index)的元素引用拷贝到newElements的[0,index)中
                System.arraycopy(elements, 0, newElements, 0, index);
                // 再将原数组中[index, index + numMoved)的元素引用拷贝到newElements的[index + 1, len + 1)中
                System.arraycopy(elements, index, newElements, index + 1,
                        numMoved);
            }

            // 将指定位置的元素放入
            newElements[index] = element;

            // 更新原数组
            setArray(newElements);
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Removes the element at the specified position in this list.
     * Shifts any subsequent elements to the left (subtracts one from their
     * indices).  Returns the element that was removed from the list.
     * 移除指定位置的元素,移动所有在指定位置右边的元素,向左移动
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E remove(int index) {
        // 上锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            // 获取当前数组
            E oldValue = get(elements, index);

            // 需要移动的数量
            int numMoved = len - index - 1;
            if (numMoved == 0)
                // 不需要移动,直接复制len的所有元素
                setArray(Arrays.copyOf(elements, len - 1));
            else {
                // 创建新数组
                Object[] newElements = new Object[len - 1];

                // 将原数组[0,index)的元素引用复制到newElements的[0, index)中
                System.arraycopy(elements, 0, newElements, 0, index);

                // 将原数组[index + 1, index + 1 + numMoved)的元素引用复制到newElements的[index, len - 1)中
                System.arraycopy(elements, index + 1, newElements, index,
                        numMoved);

                // 更新数组
                setArray(newElements);
            }

            // 返回被删除的元素
            return oldValue;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Removes the first occurrence of the specified element from this list,
     * if it is present.  If this list does not contain the element, it is
     * unchanged.  More formally, removes the element with the lowest index
     * {@code i} such that
     * <tt>(o==null&nbsp;?&nbsp;get(i)==null&nbsp;:&nbsp;o.equals(get(i)))</tt>
     * (if such an element exists).  Returns {@code true} if this list
     * contained the specified element (or equivalently, if this list
     * changed as a result of the call).
     * 移除从左到右第一次遇到与目标值相等的元素,并返回true,如果不存在则返回false
     *
     * @param o element to be removed from this list, if present
     * @return {@code true} if this list contained the specified element
     */
    public boolean remove(Object o) {
        // 未加锁时的数组快照
        Object[] snapshot = getArray();

        // 获取目标元素的位置
        int index = indexOf(o, snapshot, 0, snapshot.length);

        // 如果不存在直接返回false, 否则调用remove(p0,p1,p2)
        return (index < 0) ? false : remove(o, snapshot, index);
    }

    /**
     * A version of remove(Object) using the strong hint that given
     * recent snapshot contains o at the given index.
     */
    private boolean remove(Object o, Object[] snapshot, int index) {
        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 原数组
            Object[] current = getArray();
            int len = current.length;
            if (snapshot != current) findIndex:{
                // 在生成快照期间数组已经被更新
                int prefix = Math.min(index, len);
                for (int i = 0; i < prefix; i++) {
                    if (current[i] != snapshot[i] && eq(o, current[i])) {
                        // 如果需要删除的元素存在,则表明生成快照期间需要删除的位置左边发生删除操作
                        index = i;
                        break findIndex;
                    }
                }

                // 元素已经不存在
                if (index >= len)
                    return false;

                // 数组发生变化,但不影响删除的元素位置
                if (current[index] == o)
                    break findIndex;

                // 再次查找元素
                // 如果需要删除的元素存在,则表明生成快照期间需要删除的位置左边发生插入操作
                index = indexOf(o, current, index, len);

                // 如果需要删除的元素已经不存在,则直接返回false
                if (index < 0)
                    return false;
            }

            // 常规移除元素流程
            Object[] newElements = new Object[len - 1];

            // 将原数组[0,index)的元素引用复制到newElements的[0, index)中
            System.arraycopy(current, 0, newElements, 0, index);
            // 将原数组[index + 1, len)的元素引用复制到newElements的[index,len - 1)中
            System.arraycopy(current, index + 1,
                    newElements, index,
                    len - index - 1);

            // 更新数组
            setArray(newElements);

            return true;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Removes from this list all of the elements whose index is between
     * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
     * Shifts any succeeding elements to the left (reduces their index).
     * This call shortens the list by {@code (toIndex - fromIndex)} elements.
     * (If {@code toIndex==fromIndex}, this operation has no effect.)
     *
     * @param fromIndex index of first element to be removed
     * @param toIndex   index after last element to be removed
     * @throws IndexOutOfBoundsException if fromIndex or toIndex out of range
     *                                   ({@code fromIndex < 0 || toIndex > size() || toIndex < fromIndex})
     */
    void removeRange(int fromIndex, int toIndex) {
        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 原数组
            Object[] elements = getArray();
            int len = elements.length;

            // 如果越界直接返回
            if (fromIndex < 0 || toIndex > len || toIndex < fromIndex)
                throw new IndexOutOfBoundsException();

            // 新数组的长度
            int newLen = len - (toIndex - fromIndex);
            // 指定返回右边的元素数量
            int numMoved = len - toIndex;

            if (numMoved == 0)
                // 直接将elements中[0,fromIndex)的元素放入新数组
                setArray(Arrays.copyOf(elements, newLen));
            else {
                Object[] newElements = new Object[newLen];

                // 将原数组[0,fromIndex)的元素引用复制到newElements的[0, fromIndex)中
                System.arraycopy(elements, 0, newElements, 0, fromIndex);
                // 将原数组[toIndex, len)的元素引用复制到newElements的[fromIndex, newLen)中
                System.arraycopy(elements, toIndex, newElements,
                        fromIndex, numMoved);

                // 更新数组
                setArray(newElements);
            }
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Appends the element, if not present.
     * 当不存在这个元素时,才追加这个元素
     * @param e element to be added to this list, if absent
     * @return {@code true} if the element was added 追加成功返回true
     */
    public boolean addIfAbsent(E e) {
        // 当前数组快照
        Object[] snapshot = getArray();

        // 如果存在当前元素则直接返回false
        // 否则直接调用addIfAbsent(p0,p1)
        return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
                addIfAbsent(e, snapshot);
    }

    /**
     * A version of addIfAbsent using the strong hint that given
     * recent snapshot does not contain e.
     *
     */
    private boolean addIfAbsent(E e, Object[] snapshot) {
        // 释放
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 原数组
            Object[] current = getArray();
            int len = current.length;

            if (snapshot != current) {
                // Optimize for lost race to another addXXX operation
                // 优化 数组发生变化的情况
                int common = Math.min(snapshot.length, len);
                // 在[0,common)中查找
                for (int i = 0; i < common; i++)
                    if (current[i] != snapshot[i] && eq(e, current[i]))
                        return false;

                // 在[common,len)中查找
                if (indexOf(e, current, common, len) >= 0)
                    return false;
            }

            // 没有找到该元素
            // 创建新数组
            Object[] newElements = Arrays.copyOf(current, len + 1);

            // 则开始插入元素
            newElements[len] = e;

            // 更新数组
            setArray(newElements);
            return true;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

    /**
     * Returns {@code true} if this list contains all of the elements of the
     * specified collection.
     * 判断c中的所有元素是否都已经存在
     * @param c collection to be checked for containment in this list 被检查元素的集合
     * @return {@code true} if this list contains all of the elements of the
     * specified collection 返回true,当传入的集合中的元素都存在时
     * @throws NullPointerException if the specified collection is null 报错,如果传入的集合为null
     * @see #contains(Object)
     */
    public boolean containsAll(Collection<?> c) {
        // 获取当前元素的快照
        Object[] elements = getArray();
        int len = elements.length;

        for (Object e : c) {
            if (indexOf(e, elements, 0, len) < 0)
                // 如果该元素不存在这直接返回false
                return false;
        }
        return true;
    }

    /**
     * Removes from this list all of its elements that are contained in
     * the specified collection. This is a particularly expensive operation
     * in this class because of the need for an internal temporary array.
     *
     * @param c collection containing elements to be removed from this list
     * @return {@code true} if this list changed as a result of the call
     * @throws ClassCastException   if the class of an element of this list
     *                              is incompatible with the specified collection
     *                              (<a href="../Collection.html#optional-restrictions">optional</a>)
     * @throws NullPointerException if this list contains a null element and the
     *                              specified collection does not permit null elements
     *                              (<a href="../Collection.html#optional-restrictions">optional</a>),
     *                              or if the specified collection is null
     * @see #remove(Object)
     */
    public boolean removeAll(Collection<?> c) {
        // 判空
        if (c == null) throw new NullPointerException();

        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            // 使用当前的快照进行移除操作
            Object[] elements = getArray();
            int len = elements.length;

            if (len != 0) {
                // temp array holds those elements we know we want to keep
                // 使用temp数组去保存我们想要保留的元素
                Object[] temp = new Object[len];

                // 实际数组的长度
                int newlen = 0;

                for (int i = 0; i < len; ++i) {
                    Object element = elements[i];
                    // 将不包含的元素放入temp中
                    if (!c.contains(element))
                        temp[newlen++] = element;
                }

                // 如果确实删除了部分元素,则更新数组
                if (newlen != len) {
                    setArray(Arrays.copyOf(temp, newlen));
                    return true;
                }
            }

            // 数组中没有元素
            return false;
        } finally {
            lock.unlock();
        }
    }

    /**
     * Retains only the elements in this list that are contained in the
     * specified collection.  In other words, removes from this list all of
     * its elements that are not contained in the specified collection.
     * 保留所有存在c中的元素,删除其它不在c中的元素
     * @param c collection containing elements to be retained in this list 应该保留元素的集合
     * @return {@code true} if this list changed as a result of the call 当处理后数组发生改变则返回true,否则返回false
     * @throws ClassCastException   if the class of an element of this list
     *                              is incompatible with the specified collection
     *                              (<a href="../Collection.html#optional-restrictions">optional</a>)
     * @throws NullPointerException if this list contains a null element and the
     *                              specified collection does not permit null elements
     *                              (<a href="../Collection.html#optional-restrictions">optional</a>),
     *                              or if the specified collection is null
     * @see #remove(Object)
     */
    public boolean retainAll(Collection<?> c) {
        // 判空
        if (c == null) throw new NullPointerException();

        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            if (len != 0) {
                // temp array holds those elements we know we want to keep
                // 使用temp数组去保存我们想要保留的元素
                int newlen = 0;
                Object[] temp = new Object[len];
                for (int i = 0; i < len; ++i) {
                    Object element = elements[i];
                    // 与removeAll()的不同之处
                    if (c.contains(element))
                        // 如果包含将元素放入temp
                        temp[newlen++] = element;
                }

                // 如果确实删除了部分元素,则更新数组
                if (newlen != len) {
                    setArray(Arrays.copyOf(temp, newlen));
                    return true;
                }
            }
            return false;
        } finally {
            lock.unlock();
        }
    }

    /**
     * Appends all of the elements in the specified collection that
     * are not already contained in this list, to the end of
     * this list, in the order that they are returned by the
     * specified collection's iterator.
     *
     * @param c collection containing elements to be added to this list
     * @return the number of elements added 实际被添加的元素数量
     * @throws NullPointerException if the specified collection is null
     * @see #addIfAbsent(Object)
     */
    public int addAllAbsent(Collection<? extends E> c) {
        Object[] cs = c.toArray();

        // 如果是ArrayList时,调用toArray()返回一个安全的数组
        // 具体的调用就是这个: Arrays.copyOf(elementData, size);
        if (c.getClass() != ArrayList.class) {
            // 浅拷贝
            cs = cs.clone();
        }

        // 无实际元素,则直接返回
        if (cs.length == 0)
            return 0;

        // 加锁
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            int added = 0;
            // uniquify and compact elements in cs
            for (int i = 0; i < cs.length; ++i) {
                Object e = cs[i];

                // 跳过原数组中有的元素
                // 同时将cs中的重复元素排除
                if (indexOf(e, elements, 0, len) < 0 &&
                        indexOf(e, cs, 0, added) < 0)
                    cs[added++] = e;
            }

            // 存在添加的元素
            if (added > 0) {
                // 创建新的数组
                Object[] newElements = Arrays.copyOf(elements, len + added);

                // 将cs中[0,added)的元素复制到newElements中
                System.arraycopy(cs, 0, newElements, len, added);

                // 更新数组
                setArray(newElements);
            }

            // 返回添加的元素个数
            return added;
        } finally {
            // 释放
            lock.unlock();
        }
    }

    /**
     * Removes all of the elements from this list.
     * The list will be empty after this call returns.
     * 清除所有元素
     */
    public void clear() {
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            setArray(new Object[0]);

        } finally {
            lock.unlock();
        }
    }

    /**
     * Appends all of the elements in the specified collection to the end
     * of this list, in the order that they are returned by the specified
     * collection's iterator.
     *
     * @param c collection containing elements to be added to this list
     * @return {@code true} if this list changed as a result of the call
     * @throws NullPointerException if the specified collection is null
     * @see #add(Object)
     */
    public boolean addAll(Collection<? extends E> c) {
        // 获取安全的数组
        Object[] cs = (c.getClass() == CopyOnWriteArrayList.class) ?
                ((CopyOnWriteArrayList<?>) c).getArray() : c.toArray();

        if (cs.length == 0)
            return false;

        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            if (len == 0 && (c.getClass() == CopyOnWriteArrayList.class ||
                    c.getClass() == ArrayList.class)) {
                // 如果c属于CopyOnWriteArrayList、ArrayList则表明原集合不会影响c中的数据
                // 直接拿这个数组更新原数组
                setArray(cs);
            } else {
                // 否则复制更新
                Object[] newElements = Arrays.copyOf(elements, len + cs.length);
                System.arraycopy(cs, 0, newElements, len, cs.length);
                setArray(newElements);
            }

            return true;
        } finally {
            lock.unlock();
        }
    }

    /**
     * Inserts all of the elements in the specified collection into this
     * list, starting at the specified position.  Shifts the element
     * currently at that position (if any) and any subsequent elements to
     * the right (increases their indices).  The new elements will appear
     * in this list in the order that they are returned by the
     * specified collection's iterator.
     * 将c中的元素,全部从原数组的index位置开始插入
     * @param index index at which to insert the first element
     *              from the specified collection 第一个从c拿到的元素插入数组中的开始位置
     * @param c     collection containing elements to be added to this list
     * @return {@code true} if this list changed as a result of the call
     * @throws IndexOutOfBoundsException {@inheritDoc}
     * @throws NullPointerException      if the specified collection is null
     * @see #add(int, Object)
     */
    public boolean addAll(int index, Collection<? extends E> c) {
        Object[] cs = c.toArray();
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            if (index > len || index < 0)
                throw new IndexOutOfBoundsException("Index: " + index +
                        ", Size: " + len);

            if (cs.length == 0)
                return false;

            int numMoved = len - index;
            Object[] newElements;

            if (numMoved == 0)
                // 如果插入位置在末尾
                // 直接将原数组的元素复制过来,并且指定长度
                newElements = Arrays.copyOf(elements, len + cs.length);
            else {
                // 声明扩充后的数组
                newElements = new Object[len + cs.length];
                // 将原数组中[0,index)的元素复制到newElements的[0,index)中
                System.arraycopy(elements, 0, newElements, 0, index);
                // 将原数组中[index, len)的元素复制到newElements的[index + cs.length, len + cs.length)中
                System.arraycopy(elements, index,
                        newElements, index + cs.length,
                        numMoved);
            }

            // 将cs中[0, cs.length)的元素复制到newElements的[index, index + cs.length)中
            System.arraycopy(cs, 0, newElements, index, cs.length);

            setArray(newElements);
            return true;
        } finally {
            lock.unlock();
        }
    }

    /***
     * 让所有元素执行action
     * lambda
     * @param action
     */
    public void forEach(Consumer<? super E> action) {
        if (action == null) throw new NullPointerException();
        Object[] elements = getArray();
        int len = elements.length;

        for (int i = 0; i < len; ++i) {
            @SuppressWarnings("unchecked") E e = (E) elements[i];
            // 执行action
            action.accept(e);
        }
    }

    /***
     * 类型retainAll()、containsAll(),只是在判断时使用特定的函数filter
     * lambda
     * @param filter
     * @return
     */
    public boolean removeIf(Predicate<? super E> filter) {
        if (filter == null) throw new NullPointerException();

        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            if (len != 0) {
                int newlen = 0;
                Object[] temp = new Object[len];

                for (int i = 0; i < len; ++i) {
                    @SuppressWarnings("unchecked") E e = (E) elements[i];
                    if (!filter.test(e))
                        // 如果不满足则保存
                        temp[newlen++] = e;
                }

                // 更新
                if (newlen != len) {
                    setArray(Arrays.copyOf(temp, newlen));
                    return true;
                }
            }
            return false;
        } finally {
            lock.unlock();
        }
    }

    /***
     * 利用特定的函数operator获取应该得到的元素,这里所有的元素都会被处理
     * lambda
     * @param operator
     */
    public void replaceAll(UnaryOperator<E> operator) {
        if (operator == null) throw new NullPointerException();
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            int len = elements.length;

            Object[] newElements = Arrays.copyOf(elements, len);

            for (int i = 0; i < len; ++i) {
                @SuppressWarnings("unchecked") E e = (E) elements[i];
                // 将该元素放入指定方法处理,并更新该元素
                newElements[i] = operator.apply(e);
            }
            setArray(newElements);
        } finally {
            lock.unlock();
        }
    }

    /***
     * 使用指定的比较器进行排序
     * lambda
     * @param c
     */
    public void sort(Comparator<? super E> c) {
        final ReentrantLock lock = this.lock;
        lock.lock();

        try {
            Object[] elements = getArray();
            Object[] newElements = Arrays.copyOf(elements, elements.length);
            @SuppressWarnings("unchecked") E[] es = (E[]) newElements;

            // 通用的排序方法
            Arrays.sort(es, c);

            setArray(newElements);
        } finally {
            lock.unlock();
        }
    }

    /**
     * Saves this list to a stream (that is, serializes it).
     * 序列化,从一个类转换为一个流
     * 接口java.io.Serializable的序列化实现方法
     * @param s the stream
     * @throws java.io.IOException if an I/O error occurs
     * @serialData The length of the array backing the list is emitted
     * (int), followed by all of its elements (each an Object)
     * in the proper order.
     */
    private void writeObject(java.io.ObjectOutputStream s)
            throws java.io.IOException {

        s.defaultWriteObject();

        Object[] elements = getArray();
        // Write out array length
        // 写入数组长度
        s.writeInt(elements.length);

        // Write out all elements in the proper order.
        // 写入数组中每一个元素,调用其对应的序列化写入方法
        for (Object element : elements)
            s.writeObject(element);
    }

    /**
     * Reconstitutes this list from a stream (that is, deserializes it).
     * 反序列化,从一个流转换为一个类
     * 接口java.io.Serializable的反序列化实现方法
     * @param s the stream
     * @throws ClassNotFoundException if the class of a serialized object
     *                                could not be found
     * @throws java.io.IOException    if an I/O error occurs
     */
    private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {

        s.defaultReadObject();

        // bind to new lock
        // 绑定一个新锁
        resetLock();

        // Read in array length and allocate array
        // 读取数组长度, 并且分配数组空间
        int len = s.readInt();
        SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, len);
        Object[] elements = new Object[len];

        // Read in all elements in the proper order.
        // 读出数组中每一个元素,调用其对应的反序列化读出方法
        for (int i = 0; i < len; i++)
            elements[i] = s.readObject();

        // 更新数组
        setArray(elements);
    }

    /**
     * Returns a string representation of this list.  The string
     * representation consists of the string representations of the list's
     * elements in the order they are returned by its iterator, enclosed in
     * square brackets ({@code "[]"}).  Adjacent elements are separated by
     * the characters {@code ", "} (comma and space).  Elements are
     * converted to strings as by {@link String#valueOf(Object)}.
     * 调用Arrays.toString(p0)
     * @return a string representation of this list
     */
    public String toString() {
        return Arrays.toString(getArray());
    }

    /**
     * Compares the specified object with this list for equality.
     * Returns {@code true} if the specified object is the same object
     * as this object, or if it is also a {@link List} and the sequence
     * of elements returned by an {@linkplain List#iterator() iterator}
     * over the specified list is the same as the sequence returned by
     * an iterator over this list.  The two sequences are considered to
     * be the same if they have the same length and corresponding
     * elements at the same position in the sequence are <em>equal</em>.
     * Two elements {@code e1} and {@code e2} are considered
     * <em>equal</em> if {@code (e1==null ? e2==null : e1.equals(e2))}.
     *
     * @param o the object to be compared for equality with this list
     * @return {@code true} if the specified object is equal to this list
     */
    public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof List))
            return false;

        // 获取o的迭代器
        List<?> list = (List<?>) (o);
        Iterator<?> it = list.iterator();

        Object[] elements = getArray();
        int len = elements.length;

        // 遍历比较
        for (int i = 0; i < len; ++i)
            if (!it.hasNext() || !eq(elements[i], it.next()))
                return false;

        // 如果迭代器依然存在元素则直接返回结果
        if (it.hasNext())
            return false;

        return true;
    }

    /**
     * Returns the hash code value for this list.
     * 返回这个列表的hashcode
     * <p>This implementation uses the definition in {@link List#hashCode}.
     *
     * @return the hash code value for this list
     */
    public int hashCode() {
        int hashCode = 1;
        Object[] elements = getArray();
        int len = elements.length;

        // 累加处理每个元素的hashcode,来计算最后列表的hashcode
        for (int i = 0; i < len; ++i) {
            Object obj = elements[i];
            hashCode = 31 * hashCode + (obj == null ? 0 : obj.hashCode());
        }
        return hashCode;
    }

    /**
     * Returns an iterator over the elements in this list in proper sequence.
     *
     * <p>The returned iterator provides a snapshot of the state of the list
     * when the iterator was constructed. No synchronization is needed while
     * traversing the iterator. The iterator does <em>NOT</em> support the
     * {@code remove} method.
     *
     * @return an iterator over the elements in this list in proper sequence
     */
    public Iterator<E> iterator() {
        return new COWIterator<E>(getArray(), 0);
    }

    /**
     * {@inheritDoc}
     *
     * <p>The returned iterator provides a snapshot of the state of the list
     * when the iterator was constructed. No synchronization is needed while
     * traversing the iterator. The iterator does <em>NOT</em> support the
     * {@code remove}, {@code set} or {@code add} methods.
     */
    public ListIterator<E> listIterator() {
        return new COWIterator<E>(getArray(), 0);
    }

    /**
     * {@inheritDoc}
     *
     * <p>The returned iterator provides a snapshot of the state of the list
     * when the iterator was constructed. No synchronization is needed while
     * traversing the iterator. The iterator does <em>NOT</em> support the
     * {@code remove}, {@code set} or {@code add} methods.
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public ListIterator<E> listIterator(int index) {
        Object[] elements = getArray();
        int len = elements.length;
        if (index < 0 || index > len)
            throw new IndexOutOfBoundsException("Index: " + index);

        return new COWIterator<E>(elements, index);
    }

    /**
     * Returns a {@link Spliterator} over the elements in this list.
     *
     * <p>The {@code Spliterator} reports {@link Spliterator#IMMUTABLE},
     * {@link Spliterator#ORDERED}, {@link Spliterator#SIZED}, and
     * {@link Spliterator#SUBSIZED}.
     *
     * <p>The spliterator provides a snapshot of the state of the list
     * when the spliterator was constructed. No synchronization is needed while
     * operating on the spliterator.
     *
     * @return a {@code Spliterator} over the elements in this list
     * @since 1.8
     */
    public Spliterator<E> spliterator() {
        return Spliterators.spliterator
                (getArray(), Spliterator.IMMUTABLE | Spliterator.ORDERED);
    }

    static final class COWIterator<E> implements ListIterator<E> {
        /**
         * Snapshot of the array
         */
        private final Object[] snapshot;
        /**
         * Index of element to be returned by subsequent call to next.
         */
        private int cursor;

        private COWIterator(Object[] elements, int initialCursor) {
            cursor = initialCursor;
            snapshot = elements;
        }

        public boolean hasNext() {
            return cursor < snapshot.length;
        }

        public boolean hasPrevious() {
            return cursor > 0;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            if (!hasNext())
                throw new NoSuchElementException();
            return (E) snapshot[cursor++];
        }

        @SuppressWarnings("unchecked")
        public E previous() {
            if (!hasPrevious())
                throw new NoSuchElementException();
            return (E) snapshot[--cursor];
        }

        public int nextIndex() {
            return cursor;
        }

        public int previousIndex() {
            return cursor - 1;
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         *
         * @throws UnsupportedOperationException always; {@code remove}
         *                                       is not supported by this iterator.
         */
        public void remove() {
            throw new UnsupportedOperationException();
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         *
         * @throws UnsupportedOperationException always; {@code set}
         *                                       is not supported by this iterator.
         */
        public void set(E e) {
            throw new UnsupportedOperationException();
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         *
         * @throws UnsupportedOperationException always; {@code add}
         *                                       is not supported by this iterator.
         */
        public void add(E e) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            Object[] elements = snapshot;
            final int size = elements.length;
            for (int i = cursor; i < size; i++) {
                @SuppressWarnings("unchecked") E e = (E) elements[i];
                action.accept(e);
            }
            cursor = size;
        }
    }

    /**
     * Returns a view of the portion of this list between
     * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
     * The returned list is backed by this list, so changes in the
     * returned list are reflected in this list.
     *
     * <p>The semantics of the list returned by this method become
     * undefined if the backing list (i.e., this list) is modified in
     * any way other than via the returned list.
     *
     * @param fromIndex low endpoint (inclusive) of the subList
     * @param toIndex   high endpoint (exclusive) of the subList
     * @return a view of the specified range within this list
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public List<E> subList(int fromIndex, int toIndex) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            Object[] elements = getArray();
            int len = elements.length;
            if (fromIndex < 0 || toIndex > len || fromIndex > toIndex)
                throw new IndexOutOfBoundsException();
            return new COWSubList<E>(this, fromIndex, toIndex);
        } finally {
            lock.unlock();
        }
    }

    /**
     * Sublist for CopyOnWriteArrayList.
     * This class extends AbstractList merely for convenience, to
     * avoid having to define addAll, etc. This doesn't hurt, but
     * is wasteful.  This class does not need or use modCount
     * mechanics in AbstractList, but does need to check for
     * concurrent modification using similar mechanics.  On each
     * operation, the array that we expect the backing list to use
     * is checked and updated.  Since we do this for all of the
     * base operations invoked by those defined in AbstractList,
     * all is well.  While inefficient, this is not worth
     * improving.  The kinds of list operations inherited from
     * AbstractList are already so slow on COW sublists that
     * adding a bit more space/time doesn't seem even noticeable.
     */
    private static class COWSubList<E>
            extends AbstractList<E>
            implements RandomAccess {
        private final CopyOnWriteArrayList<E> l;
        private final int offset;
        private int size;
        private Object[] expectedArray;

        // only call this holding l's lock
        COWSubList(CopyOnWriteArrayList<E> list,
                   int fromIndex, int toIndex) {
            l = list;
            expectedArray = l.getArray();
            offset = fromIndex;
            size = toIndex - fromIndex;
        }

        // only call this holding l's lock
        private void checkForComodification() {
            if (l.getArray() != expectedArray)
                throw new ConcurrentModificationException();
        }

        // only call this holding l's lock
        private void rangeCheck(int index) {
            if (index < 0 || index >= size)
                throw new IndexOutOfBoundsException("Index: " + index +
                        ",Size: " + size);
        }

        public E set(int index, E element) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                rangeCheck(index);
                checkForComodification();
                E x = l.set(index + offset, element);
                expectedArray = l.getArray();
                return x;
            } finally {
                lock.unlock();
            }
        }

        public E get(int index) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                rangeCheck(index);
                checkForComodification();
                return l.get(index + offset);
            } finally {
                lock.unlock();
            }
        }

        public int size() {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                return size;
            } finally {
                lock.unlock();
            }
        }

        public void add(int index, E element) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                if (index < 0 || index > size)
                    throw new IndexOutOfBoundsException();
                l.add(index + offset, element);
                expectedArray = l.getArray();
                size++;
            } finally {
                lock.unlock();
            }
        }

        public void clear() {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                l.removeRange(offset, offset + size);
                expectedArray = l.getArray();
                size = 0;
            } finally {
                lock.unlock();
            }
        }

        public E remove(int index) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                rangeCheck(index);
                checkForComodification();
                E result = l.remove(index + offset);
                expectedArray = l.getArray();
                size--;
                return result;
            } finally {
                lock.unlock();
            }
        }

        public boolean remove(Object o) {
            int index = indexOf(o);
            if (index == -1)
                return false;
            remove(index);
            return true;
        }

        public Iterator<E> iterator() {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                return new COWSubListIterator<E>(l, 0, offset, size);
            } finally {
                lock.unlock();
            }
        }

        public ListIterator<E> listIterator(int index) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                if (index < 0 || index > size)
                    throw new IndexOutOfBoundsException("Index: " + index +
                            ", Size: " + size);
                return new COWSubListIterator<E>(l, index, offset, size);
            } finally {
                lock.unlock();
            }
        }

        public List<E> subList(int fromIndex, int toIndex) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                checkForComodification();
                if (fromIndex < 0 || toIndex > size || fromIndex > toIndex)
                    throw new IndexOutOfBoundsException();
                return new COWSubList<E>(l, fromIndex + offset,
                        toIndex + offset);
            } finally {
                lock.unlock();
            }
        }

        public void forEach(Consumer<? super E> action) {
            if (action == null) throw new NullPointerException();
            int lo = offset;
            int hi = offset + size;
            Object[] a = expectedArray;
            if (l.getArray() != a)
                throw new ConcurrentModificationException();
            if (lo < 0 || hi > a.length)
                throw new IndexOutOfBoundsException();
            for (int i = lo; i < hi; ++i) {
                @SuppressWarnings("unchecked") E e = (E) a[i];
                action.accept(e);
            }
        }

        public void replaceAll(UnaryOperator<E> operator) {
            if (operator == null) throw new NullPointerException();
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                int lo = offset;
                int hi = offset + size;
                Object[] elements = expectedArray;
                if (l.getArray() != elements)
                    throw new ConcurrentModificationException();
                int len = elements.length;
                if (lo < 0 || hi > len)
                    throw new IndexOutOfBoundsException();
                Object[] newElements = Arrays.copyOf(elements, len);
                for (int i = lo; i < hi; ++i) {
                    @SuppressWarnings("unchecked") E e = (E) elements[i];
                    newElements[i] = operator.apply(e);
                }
                l.setArray(expectedArray = newElements);
            } finally {
                lock.unlock();
            }
        }

        public void sort(Comparator<? super E> c) {
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                int lo = offset;
                int hi = offset + size;
                Object[] elements = expectedArray;
                if (l.getArray() != elements)
                    throw new ConcurrentModificationException();
                int len = elements.length;
                if (lo < 0 || hi > len)
                    throw new IndexOutOfBoundsException();
                Object[] newElements = Arrays.copyOf(elements, len);
                @SuppressWarnings("unchecked") E[] es = (E[]) newElements;
                Arrays.sort(es, lo, hi, c);
                l.setArray(expectedArray = newElements);
            } finally {
                lock.unlock();
            }
        }

        public boolean removeAll(Collection<?> c) {
            if (c == null) throw new NullPointerException();
            boolean removed = false;
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                int n = size;
                if (n > 0) {
                    int lo = offset;
                    int hi = offset + n;
                    Object[] elements = expectedArray;
                    if (l.getArray() != elements)
                        throw new ConcurrentModificationException();
                    int len = elements.length;
                    if (lo < 0 || hi > len)
                        throw new IndexOutOfBoundsException();
                    int newSize = 0;
                    Object[] temp = new Object[n];
                    for (int i = lo; i < hi; ++i) {
                        Object element = elements[i];
                        if (!c.contains(element))
                            temp[newSize++] = element;
                    }
                    if (newSize != n) {
                        Object[] newElements = new Object[len - n + newSize];
                        System.arraycopy(elements, 0, newElements, 0, lo);
                        System.arraycopy(temp, 0, newElements, lo, newSize);
                        System.arraycopy(elements, hi, newElements,
                                lo + newSize, len - hi);
                        size = newSize;
                        removed = true;
                        l.setArray(expectedArray = newElements);
                    }
                }
            } finally {
                lock.unlock();
            }
            return removed;
        }

        public boolean retainAll(Collection<?> c) {
            if (c == null) throw new NullPointerException();
            boolean removed = false;
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                int n = size;
                if (n > 0) {
                    int lo = offset;
                    int hi = offset + n;
                    Object[] elements = expectedArray;
                    if (l.getArray() != elements)
                        throw new ConcurrentModificationException();
                    int len = elements.length;
                    if (lo < 0 || hi > len)
                        throw new IndexOutOfBoundsException();
                    int newSize = 0;
                    Object[] temp = new Object[n];
                    for (int i = lo; i < hi; ++i) {
                        Object element = elements[i];
                        if (c.contains(element))
                            temp[newSize++] = element;
                    }
                    if (newSize != n) {
                        Object[] newElements = new Object[len - n + newSize];
                        System.arraycopy(elements, 0, newElements, 0, lo);
                        System.arraycopy(temp, 0, newElements, lo, newSize);
                        System.arraycopy(elements, hi, newElements,
                                lo + newSize, len - hi);
                        size = newSize;
                        removed = true;
                        l.setArray(expectedArray = newElements);
                    }
                }
            } finally {
                lock.unlock();
            }
            return removed;
        }

        public boolean removeIf(Predicate<? super E> filter) {
            if (filter == null) throw new NullPointerException();
            boolean removed = false;
            final ReentrantLock lock = l.lock;
            lock.lock();
            try {
                int n = size;
                if (n > 0) {
                    int lo = offset;
                    int hi = offset + n;
                    Object[] elements = expectedArray;
                    if (l.getArray() != elements)
                        throw new ConcurrentModificationException();
                    int len = elements.length;
                    if (lo < 0 || hi > len)
                        throw new IndexOutOfBoundsException();
                    int newSize = 0;
                    Object[] temp = new Object[n];
                    for (int i = lo; i < hi; ++i) {
                        @SuppressWarnings("unchecked") E e = (E) elements[i];
                        if (!filter.test(e))
                            temp[newSize++] = e;
                    }
                    if (newSize != n) {
                        Object[] newElements = new Object[len - n + newSize];
                        System.arraycopy(elements, 0, newElements, 0, lo);
                        System.arraycopy(temp, 0, newElements, lo, newSize);
                        System.arraycopy(elements, hi, newElements,
                                lo + newSize, len - hi);
                        size = newSize;
                        removed = true;
                        l.setArray(expectedArray = newElements);
                    }
                }
            } finally {
                lock.unlock();
            }
            return removed;
        }

        public Spliterator<E> spliterator() {
            int lo = offset;
            int hi = offset + size;
            Object[] a = expectedArray;
            if (l.getArray() != a)
                throw new ConcurrentModificationException();
            if (lo < 0 || hi > a.length)
                throw new IndexOutOfBoundsException();
            return Spliterators.spliterator
                    (a, lo, hi, Spliterator.IMMUTABLE | Spliterator.ORDERED);
        }

    }

    private static class COWSubListIterator<E> implements ListIterator<E> {
        private final ListIterator<E> it;
        private final int offset;
        private final int size;

        COWSubListIterator(List<E> l, int index, int offset, int size) {
            this.offset = offset;
            this.size = size;
            it = l.listIterator(index + offset);
        }

        public boolean hasNext() {
            return nextIndex() < size;
        }

        public E next() {
            if (hasNext())
                return it.next();
            else
                throw new NoSuchElementException();
        }

        public boolean hasPrevious() {
            return previousIndex() >= 0;
        }

        public E previous() {
            if (hasPrevious())
                return it.previous();
            else
                throw new NoSuchElementException();
        }

        public int nextIndex() {
            return it.nextIndex() - offset;
        }

        public int previousIndex() {
            return it.previousIndex() - offset;
        }

        public void remove() {
            throw new UnsupportedOperationException();
        }

        public void set(E e) {
            throw new UnsupportedOperationException();
        }

        public void add(E e) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            int s = size;
            ListIterator<E> i = it;
            while (nextIndex() < s) {
                action.accept(i.next());
            }
        }
    }

    // Support for resetting lock while deserializing
    private void resetLock() {
        UNSAFE.putObjectVolatile(this, lockOffset, new ReentrantLock());
    }

    private static final sun.misc.Unsafe UNSAFE;
    private static final long lockOffset;

    static {
        try {
            UNSAFE = sun.misc.Unsafe.getUnsafe();
            Class<?> k = CopyOnWriteArrayList.class;
            lockOffset = UNSAFE.objectFieldOffset
                    (k.getDeclaredField("lock"));
        } catch (Exception e) {
            throw new Error(e);
        }
    }
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值