com.gs.collections.impl.list.mutable.SynchronizedMutableList Maven / Gradle / Ivy
Show all versions of gs-collections Show documentation
/*
* Copyright 2015 Goldman Sachs.
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
package com.gs.collections.impl.list.mutable;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.ListIterator;
import java.util.Random;
import java.util.concurrent.ExecutorService;
import com.gs.collections.api.LazyIterable;
import com.gs.collections.api.block.HashingStrategy;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.function.primitive.BooleanFunction;
import com.gs.collections.api.block.function.primitive.ByteFunction;
import com.gs.collections.api.block.function.primitive.CharFunction;
import com.gs.collections.api.block.function.primitive.DoubleFunction;
import com.gs.collections.api.block.function.primitive.FloatFunction;
import com.gs.collections.api.block.function.primitive.IntFunction;
import com.gs.collections.api.block.function.primitive.LongFunction;
import com.gs.collections.api.block.function.primitive.ShortFunction;
import com.gs.collections.api.block.predicate.Predicate;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure;
import com.gs.collections.api.list.ImmutableList;
import com.gs.collections.api.list.MutableList;
import com.gs.collections.api.list.ParallelListIterable;
import com.gs.collections.api.list.primitive.MutableBooleanList;
import com.gs.collections.api.list.primitive.MutableByteList;
import com.gs.collections.api.list.primitive.MutableCharList;
import com.gs.collections.api.list.primitive.MutableDoubleList;
import com.gs.collections.api.list.primitive.MutableFloatList;
import com.gs.collections.api.list.primitive.MutableIntList;
import com.gs.collections.api.list.primitive.MutableLongList;
import com.gs.collections.api.list.primitive.MutableShortList;
import com.gs.collections.api.multimap.list.MutableListMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.list.PartitionMutableList;
import com.gs.collections.api.stack.MutableStack;
import com.gs.collections.api.tuple.Pair;
import com.gs.collections.impl.block.factory.HashingStrategies;
import com.gs.collections.impl.collection.mutable.AbstractSynchronizedMutableCollection;
import com.gs.collections.impl.collection.mutable.SynchronizedCollectionSerializationProxy;
import com.gs.collections.impl.lazy.ReverseIterable;
import com.gs.collections.impl.lazy.parallel.list.SynchronizedParallelListIterable;
import net.jcip.annotations.GuardedBy;
/**
* A synchronized view of a {@link MutableList}. It is imperative that the user manually synchronize on the collection when iterating over it using the
* standard JDK iterator or JDK 5 for loop, as per {@link Collections#synchronizedCollection(Collection)}.
*
* @see MutableList#asSynchronized()
*/
public class SynchronizedMutableList
extends AbstractSynchronizedMutableCollection
implements MutableList, Serializable
{
private static final long serialVersionUID = 2L;
SynchronizedMutableList(MutableList newCollection)
{
super(newCollection);
}
SynchronizedMutableList(MutableList newCollection, Object newLock)
{
super(newCollection, newLock);
}
/**
* This method will take a MutableList and wrap it directly in a SynchronizedMutableList. It will
* take any other non-GS-collection and first adapt it will a ListAdapter, and then return a
* SynchronizedMutableList that wraps the adapter.
*/
public static > SynchronizedMutableList of(L list)
{
MutableList mutableList =
list instanceof MutableList ? (MutableList) list : ListAdapter.adapt(list);
return new SynchronizedMutableList(mutableList);
}
/**
* This method will take a MutableList and wrap it directly in a SynchronizedMutableList. It will
* take any other non-GS-collection and first adapt it will a ListAdapter, and then return a
* SynchronizedMutableList that wraps the adapter. Additionally, a developer specifies which lock to use
* with the collection.
*/
public static > SynchronizedMutableList of(L list, Object lock)
{
MutableList mutableList =
list instanceof MutableList ? (MutableList) list : ListAdapter.adapt(list);
return new SynchronizedMutableList(mutableList, lock);
}
@Override
@GuardedBy("getLock()")
protected MutableList getDelegate()
{
return (MutableList) super.getDelegate();
}
public MutableList with(T element)
{
this.add(element);
return this;
}
public MutableList without(T element)
{
this.remove(element);
return this;
}
public MutableList withAll(Iterable elements)
{
this.addAllIterable(elements);
return this;
}
public MutableList withoutAll(Iterable elements)
{
this.removeAllIterable(elements);
return this;
}
public MutableList newEmpty()
{
synchronized (this.getLock())
{
return this.getDelegate().newEmpty().asSynchronized();
}
}
@Override
public MutableList clone()
{
synchronized (this.getLock())
{
return SynchronizedMutableList.of(this.getDelegate().clone());
}
}
protected Object writeReplace()
{
return new SynchronizedCollectionSerializationProxy(this.getDelegate());
}
public boolean addAll(int index, Collection collection)
{
synchronized (this.getLock())
{
return this.getDelegate().addAll(index, collection);
}
}
public T set(int index, T element)
{
synchronized (this.getLock())
{
return this.getDelegate().set(index, element);
}
}
public void add(int index, T element)
{
synchronized (this.getLock())
{
this.getDelegate().add(index, element);
}
}
public T remove(int index)
{
synchronized (this.getLock())
{
return this.getDelegate().remove(index);
}
}
public MutableList subList(int fromIndex, int toIndex)
{
synchronized (this.getLock())
{
return SynchronizedMutableList.of(this.getDelegate().subList(fromIndex, toIndex), this.getLock());
}
}
public T get(int index)
{
synchronized (this.getLock())
{
return this.getDelegate().get(index);
}
}
public int lastIndexOf(Object o)
{
synchronized (this.getLock())
{
return this.getDelegate().lastIndexOf(o);
}
}
public ListIterator listIterator()
{
return this.getDelegate().listIterator();
}
public ListIterator listIterator(int index)
{
return this.getDelegate().listIterator(index);
}
public ParallelListIterable asParallel(ExecutorService executorService, int batchSize)
{
return new SynchronizedParallelListIterable(this.getDelegate().asParallel(executorService, batchSize), this.getLock());
}
public int binarySearch(T key, Comparator comparator)
{
synchronized (this.getLock())
{
return Collections.binarySearch(this, key, comparator);
}
}
public int binarySearch(T key)
{
synchronized (this.getLock())
{
return Collections.binarySearch((List>) this, key);
}
}
public int indexOf(Object o)
{
synchronized (this.getLock())
{
return this.getDelegate().indexOf(o);
}
}
public MutableList distinct()
{
synchronized (this.getLock())
{
return this.getDelegate().distinct();
}
}
public MutableList distinct(HashingStrategy hashingStrategy)
{
synchronized (this.getLock())
{
return this.getDelegate().distinct(hashingStrategy);
}
}
public boolean corresponds(OrderedIterable other, Predicate2 predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().corresponds(other, predicate);
}
}
public void forEach(int fromIndex, int toIndex, Procedure procedure)
{
synchronized (this.getLock())
{
this.getDelegate().forEach(fromIndex, toIndex, procedure);
}
}
public MutableList takeWhile(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().takeWhile(predicate);
}
}
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure objectIntProcedure)
{
synchronized (this.getLock())
{
this.getDelegate().forEachWithIndex(fromIndex, toIndex, objectIntProcedure);
}
}
public MutableList dropWhile(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().dropWhile(predicate);
}
}
public PartitionMutableList partitionWhile(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().partitionWhile(predicate);
}
}
public int detectIndex(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().detectIndex(predicate);
}
}
public int detectLastIndex(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().detectLastIndex(predicate);
}
}
public MutableList take(int count)
{
synchronized (this.getLock())
{
return this.getDelegate().take(count);
}
}
public MutableList drop(int count)
{
synchronized (this.getLock())
{
return this.getDelegate().drop(count);
}
}
public void reverseForEach(Procedure procedure)
{
synchronized (this.getLock())
{
this.getDelegate().reverseForEach(procedure);
}
}
public MutableList sortThis(Comparator comparator)
{
synchronized (this.getLock())
{
this.getDelegate().sortThis(comparator);
return this;
}
}
public MutableList sortThis()
{
synchronized (this.getLock())
{
this.getDelegate().sortThis();
return this;
}
}
public > MutableList sortThisBy(Function function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisBy(function);
return this;
}
}
public MutableList sortThisByInt(IntFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByInt(function);
return this;
}
}
public MutableList sortThisByBoolean(BooleanFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByBoolean(function);
return this;
}
}
public MutableList sortThisByChar(CharFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByChar(function);
return this;
}
}
public MutableList sortThisByByte(ByteFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByByte(function);
return this;
}
}
public MutableList sortThisByShort(ShortFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByShort(function);
return this;
}
}
public MutableList sortThisByFloat(FloatFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByFloat(function);
return this;
}
}
public MutableList sortThisByLong(LongFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByLong(function);
return this;
}
}
public MutableList sortThisByDouble(DoubleFunction function)
{
synchronized (this.getLock())
{
this.getDelegate().sortThisByDouble(function);
return this;
}
}
public MutableList reverseThis()
{
synchronized (this.getLock())
{
this.getDelegate().reverseThis();
return this;
}
}
public MutableList shuffleThis()
{
synchronized (this.getLock())
{
this.getDelegate().shuffleThis();
return this;
}
}
public MutableList shuffleThis(Random rnd)
{
synchronized (this.getLock())
{
this.getDelegate().shuffleThis(rnd);
return this;
}
}
public LazyIterable asReversed()
{
synchronized (this.getLock())
{
return ReverseIterable.adapt(this);
}
}
public MutableList toReversed()
{
synchronized (this.getLock())
{
return this.getDelegate().toReversed();
}
}
public MutableStack toStack()
{
synchronized (this.getLock())
{
return this.getDelegate().toStack();
}
}
public ImmutableList toImmutable()
{
synchronized (this.getLock())
{
return this.getDelegate().toImmutable();
}
}
public MutableList tap(Procedure procedure)
{
synchronized (this.getLock())
{
this.forEach(procedure);
return this;
}
}
public MutableList select(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().select(predicate);
}
}
public MutableList selectWith(
Predicate2 predicate,
P parameter)
{
synchronized (this.getLock())
{
return this.getDelegate().selectWith(predicate, parameter);
}
}
public MutableList reject(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().reject(predicate);
}
}
public MutableList rejectWith(Predicate2 predicate, P parameter)
{
synchronized (this.getLock())
{
return this.getDelegate().rejectWith(predicate, parameter);
}
}
public PartitionMutableList partition(Predicate predicate)
{
synchronized (this.getLock())
{
return this.getDelegate().partition(predicate);
}
}
public PartitionMutableList partitionWith(Predicate2 predicate, P parameter)
{
synchronized (this.getLock())
{
return this.getDelegate().partitionWith(predicate, parameter);
}
}
public MutableList selectInstancesOf(Class clazz)
{
synchronized (this.getLock())
{
return this.getDelegate().selectInstancesOf(clazz);
}
}
public MutableBooleanList collectBoolean(BooleanFunction booleanFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectBoolean(booleanFunction);
}
}
public MutableByteList collectByte(ByteFunction byteFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectByte(byteFunction);
}
}
public MutableCharList collectChar(CharFunction charFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectChar(charFunction);
}
}
public MutableDoubleList collectDouble(DoubleFunction doubleFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectDouble(doubleFunction);
}
}
public MutableFloatList collectFloat(FloatFunction floatFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectFloat(floatFunction);
}
}
public MutableIntList collectInt(IntFunction intFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectInt(intFunction);
}
}
public MutableLongList collectLong(LongFunction longFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectLong(longFunction);
}
}
public MutableShortList collectShort(ShortFunction shortFunction)
{
synchronized (this.getLock())
{
return this.getDelegate().collectShort(shortFunction);
}
}
public MutableList collect(Function function)
{
synchronized (this.getLock())
{
return this.getDelegate().collect(function);
}
}
public MutableList collectWith(Function2 function, P parameter)
{
synchronized (this.getLock())
{
return this.getDelegate().collectWith(function, parameter);
}
}
public MutableList collectIf(
Predicate predicate,
Function function)
{
synchronized (this.getLock())
{
return this.getDelegate().collectIf(predicate, function);
}
}
public MutableList flatCollect(Function> function)
{
synchronized (this.getLock())
{
return this.getDelegate().flatCollect(function);
}
}
public MutableListMultimap groupBy(Function function)
{
synchronized (this.getLock())
{
return this.getDelegate().groupBy(function);
}
}
public MutableListMultimap groupByEach(Function> function)
{
synchronized (this.getLock())
{
return this.getDelegate().groupByEach(function);
}
}
public MutableList> zip(Iterable that)
{
synchronized (this.getLock())
{
return this.getDelegate().zip(that);
}
}
public MutableList> zipWithIndex()
{
synchronized (this.getLock())
{
return this.getDelegate().zipWithIndex();
}
}
public MutableList asUnmodifiable()
{
synchronized (this.getLock())
{
return UnmodifiableMutableList.of(this);
}
}
public MutableList asSynchronized()
{
return this;
}
}