com.cedarsoftware.util.ConcurrentList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-util Show documentation
Java Utilities
There is a newer version: 2.18.0
package com.cedarsoftware.util;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.function.Supplier;

/**
 * ConcurrentList provides a List and List wrapper that is thread-safe, usable in highly concurrent
 * environments. It provides a no-arg constructor that will directly return a ConcurrentList that is
 * thread-safe.  It has a constructor that takes a List argument, which will wrap that List and make it
 * thread-safe (no elements are duplicated).

 * 

 * The iterator(), listIterator() return read-only views copied from the list.  The listIterator(index)
 * is not implemented, as the inbound index could already be outside the lists position due to concurrent
 * edits.  Similarly, subList(from, to) is not implemented because the boundaries may exceed the lists
 * size due to concurrent edits.
 * 


 * @author John DeRegnaucourt ([email protected])
 *         

 *         Copyright (c) Cedar Software LLC
 *         


 *         Licensed under the Apache License, Version 2.0 (the "License");
 *         you may not use this file except in compliance with the License.
 *         You may obtain a copy of the License at
 *         


 *         License
 *         


 *         Unless required by applicable law or agreed to in writing, software
 *         distributed under the License is distributed on an "AS IS" BASIS,
 *         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *         See the License for the specific language governing permissions and
 *         limitations under the License.
 */
public class ConcurrentList implements List {
    private final List list;
    private final transient ReadWriteLock lock = new ReentrantReadWriteLock();

    /**
     * No-arg constructor to create an empty ConcurrentList, wrapping an ArrayList.
     */
    public ConcurrentList() {
        this.list = new ArrayList<>();
    }

    /**
     * Use this constructor to wrap a List (any kind of List) and make it a ConcurrentList.
     * No duplicate of the List is created and the original list is operated on directly.
     * @param list List instance to protect.
     */
    public ConcurrentList(List list) {
        if (list == null) {
            throw new IllegalArgumentException("List cannot be null");
        }
        this.list = list;
    }

    // Immutable APIs
    public boolean equals(Object other) { return readOperation(() -> list.equals(other)); }
    public int hashCode() { return readOperation(list::hashCode); }
    public String toString() { return readOperation(list::toString); }
    public int size() { return readOperation(list::size); }
    public boolean isEmpty() { return readOperation(list::isEmpty); }
    public boolean contains(Object o) { return readOperation(() -> list.contains(o)); }
    public boolean containsAll(Collection c) { return readOperation(() -> new HashSet<>(list).containsAll(c)); }
    public E get(int index) { return readOperation(() -> list.get(index)); }
    public int indexOf(Object o) { return readOperation(() -> list.indexOf(o)); }
    public int lastIndexOf(Object o) { return readOperation(() -> list.lastIndexOf(o)); }
    public Iterator iterator() { return readOperation(() -> new ArrayList<>(list).iterator()); }
    public Object[] toArray() { return readOperation(list::toArray); }
    public  T[] toArray(T[] a) { return readOperation(() -> list.toArray(a)); }

    // Mutable APIs
    public boolean add(E e) { return writeOperation(() -> list.add(e)); }
    public boolean addAll(Collection c) { return writeOperation(() -> list.addAll(c)); }
    public boolean addAll(int index, Collection c) { return writeOperation(() -> list.addAll(index, c)); }
    public void add(int index, E element) {
        writeOperation(() -> {
            list.add(index, element);
            return null;
        });
    }
    public E set(int index, E element) { return writeOperation(() -> list.set(index, element)); }
    public E remove(int index) { return writeOperation(() -> list.remove(index)); }
    public boolean remove(Object o) { return writeOperation(() -> list.remove(o)); }
    public boolean removeAll(Collection c) { return writeOperation(() -> list.removeAll(c)); }
    public boolean retainAll(Collection c) { return writeOperation(() -> list.retainAll(c)); }
    public void clear() {
        writeOperation(() -> {
            list.clear();
            return null; // To comply with the Supplier return type
        });
    }
    public ListIterator listIterator() { return readOperation(() -> new ArrayList<>(list).listIterator()); }

    // Unsupported operations
    public ListIterator listIterator(int index) { throw new UnsupportedOperationException("listIterator(index) not implemented for ConcurrentList"); }
    public List subList(int fromIndex, int toIndex) { throw new UnsupportedOperationException("subList not implemented for ConcurrentList"); }

    private  T readOperation(Supplier operation) {
        lock.readLock().lock();
        try {
            return operation.get();
        } finally {
            lock.readLock().unlock();
        }
    }

    private  T writeOperation(Supplier operation) {
        lock.writeLock().lock();
        try {
            return operation.get();
        } finally {
            lock.writeLock().unlock();
        }
    }
}