/*
* 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.map.mutable;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import com.gs.collections.api.RichIterable;
import com.gs.collections.api.bag.MutableBag;
import com.gs.collections.api.bag.primitive.MutableBooleanBag;
import com.gs.collections.api.bag.primitive.MutableByteBag;
import com.gs.collections.api.bag.primitive.MutableCharBag;
import com.gs.collections.api.bag.primitive.MutableDoubleBag;
import com.gs.collections.api.bag.primitive.MutableFloatBag;
import com.gs.collections.api.bag.primitive.MutableIntBag;
import com.gs.collections.api.bag.primitive.MutableLongBag;
import com.gs.collections.api.bag.primitive.MutableShortBag;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function0;
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.Procedure2;
import com.gs.collections.api.map.ImmutableMap;
import com.gs.collections.api.map.MutableMap;
import com.gs.collections.api.multimap.bag.MutableBagMultimap;
import com.gs.collections.api.multimap.set.MutableSetMultimap;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.bag.PartitionMutableBag;
import com.gs.collections.api.set.MutableSet;
import com.gs.collections.api.tuple.Pair;
import com.gs.collections.impl.collection.mutable.SynchronizedMutableCollection;
import com.gs.collections.impl.factory.Maps;
import com.gs.collections.impl.list.fixed.ArrayAdapter;
import com.gs.collections.impl.map.AbstractSynchronizedMapIterable;
import com.gs.collections.impl.set.mutable.SynchronizedMutableSet;
import com.gs.collections.impl.utility.LazyIterate;
/**
* A synchronized view of a {@link MutableMap}. 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 MutableMap#asSynchronized()
*/
public class SynchronizedMutableMap<K, V>
extends AbstractSynchronizedMapIterable<K, V> implements MutableMap<K, V>, Serializable
{
private static final long serialVersionUID = 2L;
public SynchronizedMutableMap(MutableMap<K, V> newMap)
{
super(newMap);
}
public SynchronizedMutableMap(MutableMap<K, V> newMap, Object newLock)
{
super(newMap, newLock);
}
/**
* This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap. It will
* take any other non-GS-map and first adapt it will a MapAdapter, and then return a
* SynchronizedMutableMap that wraps the adapter.
*/
public static <K, V, M extends Map<K, V>> SynchronizedMutableMap<K, V> of(M map)
{
if (map == null)
{
throw new IllegalArgumentException("cannot create a SynchronizedMutableMap for null");
}
return new SynchronizedMutableMap<K, V>(MapAdapter.adapt(map));
}
/**
* This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap. It will
* take any other non-GS-map and first adapt it will a MapAdapter, and then return a
* SynchronizedMutableMap that wraps the adapter. Additionally, a developer specifies which lock to use
* with the collection.
*/
public static <K, V, M extends Map<K, V>> SynchronizedMutableMap<K, V> of(M map, Object lock)
{
if (map == null)
{
throw new IllegalArgumentException("cannot create a SynchronizedMutableMap for null");
}
return new SynchronizedMutableMap<K, V>(MapAdapter.adapt(map), lock);
}
public MutableMap<K, V> withKeyValue(K key, V value)
{
synchronized (this.lock)
{
this.put(key, value);
return this;
}
}
public MutableMap<K, V> withAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValuePairs)
{
return this.withAllKeyValues(ArrayAdapter.adapt(keyValuePairs));
}
public MutableMap<K, V> withAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)
{
synchronized (this.lock)
{
for (Pair<? extends K, ? extends V> keyValue : keyValues)
{
this.getDelegate().put(keyValue.getOne(), keyValue.getTwo());
}
return this;
}
}
public MutableMap<K, V> withoutKey(K key)
{
this.remove(key);
return this;
}
public MutableMap<K, V> withoutAllKeys(Iterable<? extends K> keys)
{
synchronized (this.lock)
{
for (K key : keys)
{
this.getDelegate().removeKey(key);
}
return this;
}
}
public MutableMap<K, V> newEmpty()
{
synchronized (this.lock)
{
return this.getDelegate().newEmpty();
}
}
@Override
public MutableMap<K, V> clone()
{
synchronized (this.lock)
{
return SynchronizedMutableMap.of(this.getDelegate().clone());
}
}
protected Object writeReplace()
{
return new SynchronizedMapSerializationProxy<K, V>(this.getDelegate());
}
@Override
protected MutableMap<K, V> getDelegate()
{
return (MutableMap<K, V>) super.getDelegate();
}
public <E> MutableMap<K, V> collectKeysAndValues(
Iterable<E> iterable,
Function<? super E, ? extends K> keyFunction,
Function<? super E, ? extends V> function)
{
synchronized (this.lock)
{
return this.getDelegate().collectKeysAndValues(iterable, keyFunction, function);
}
}
public MutableMap<K, V> select(Predicate2<? super K, ? super V> predicate)
{
synchronized (this.lock)
{
return this.getDelegate().select(predicate);
}
}
public MutableMap<K, V> reject(Predicate2<? super K, ? super V> predicate)
{
synchronized (this.lock)
{
return this.getDelegate().reject(predicate);
}
}
public <K2, V2> MutableMap<K2, V2> collect(Function2<? super K, ? super V, Pair<K2, V2>> pairFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collect(pairFunction);
}
}
public <R> MutableMap<K, R> collectValues(Function2<? super K, ? super V, ? extends R> function)
{
synchronized (this.lock)
{
return this.getDelegate().collectValues(function);
}
}
public MutableMap<K, V> tap(Procedure<? super V> procedure)
{
synchronized (this.lock)
{
this.forEach(procedure);
return this;
}
}
public MutableBag<V> select(Predicate<? super V> predicate)
{
synchronized (this.lock)
{
return this.getDelegate().select(predicate);
}
}
public <P> MutableBag<V> selectWith(Predicate2<? super V, ? super P> predicate, P parameter)
{
synchronized (this.lock)
{
return this.getDelegate().selectWith(predicate, parameter);
}
}
public MutableBag<V> reject(Predicate<? super V> predicate)
{
synchronized (this.lock)
{
return this.getDelegate().reject(predicate);
}
}
public <P> MutableBag<V> rejectWith(Predicate2<? super V, ? super P> predicate, P parameter)
{
synchronized (this.lock)
{
return this.getDelegate().rejectWith(predicate, parameter);
}
}
public PartitionMutableBag<V> partition(Predicate<? super V> predicate)
{
synchronized (this.lock)
{
return this.getDelegate().partition(predicate);
}
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Deprecated
public MutableSet<Pair<V, Integer>> zipWithIndex()
{
synchronized (this.lock)
{
return this.getDelegate().zipWithIndex();
}
}
public <P> PartitionMutableBag<V> partitionWith(Predicate2<? super V, ? super P> predicate, P parameter)
{
synchronized (this.lock)
{
return this.getDelegate().partitionWith(predicate, parameter);
}
}
public <S> MutableBag<S> selectInstancesOf(Class<S> clazz)
{
synchronized (this.lock)
{
return this.getDelegate().selectInstancesOf(clazz);
}
}
public <A> MutableBag<A> collect(Function<? super V, ? extends A> function)
{
synchronized (this.lock)
{
return this.getDelegate().collect(function);
}
}
public MutableBooleanBag collectBoolean(BooleanFunction<? super V> booleanFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectBoolean(booleanFunction);
}
}
public MutableByteBag collectByte(ByteFunction<? super V> byteFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectByte(byteFunction);
}
}
public MutableCharBag collectChar(CharFunction<? super V> charFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectChar(charFunction);
}
}
public MutableDoubleBag collectDouble(DoubleFunction<? super V> doubleFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectDouble(doubleFunction);
}
}
public MutableFloatBag collectFloat(FloatFunction<? super V> floatFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectFloat(floatFunction);
}
}
public MutableIntBag collectInt(IntFunction<? super V> intFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectInt(intFunction);
}
}
public MutableLongBag collectLong(LongFunction<? super V> longFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectLong(longFunction);
}
}
public MutableShortBag collectShort(ShortFunction<? super V> shortFunction)
{
synchronized (this.lock)
{
return this.getDelegate().collectShort(shortFunction);
}
}
public <P, A> MutableBag<A> collectWith(Function2<? super V, ? super P, ? extends A> function, P parameter)
{
synchronized (this.lock)
{
return this.getDelegate().collectWith(function, parameter);
}
}
public <A> MutableBag<A> collectIf(Predicate<? super V> predicate, Function<? super V, ? extends A> function)
{
synchronized (this.lock)
{
return this.getDelegate().collectIf(predicate, function);
}
}
public <A> MutableBag<A> flatCollect(Function<? super V, ? extends Iterable<A>> function)
{
synchronized (this.lock)
{
return this.getDelegate().flatCollect(function);
}
}
public <KK> MutableBagMultimap<KK, V> groupBy(Function<? super V, ? extends KK> function)
{
synchronized (this.lock)
{
return this.getDelegate().groupBy(function);
}
}
public <KK> MutableBagMultimap<KK, V> groupByEach(Function<? super V, ? extends Iterable<KK>> function)
{
synchronized (this.lock)
{
return this.getDelegate().groupByEach(function);
}
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Deprecated
public <S> MutableBag<Pair<V, S>> zip(Iterable<S> that)
{
synchronized (this.lock)
{
return this.getDelegate().zip(that);
}
}
public <K2, V2> MutableMap<K2, V2> aggregateInPlaceBy(
Function<? super V, ? extends K2> groupBy,
Function0<? extends V2> zeroValueFactory,
Procedure2<? super V2, ? super V> mutatingAggregator)
{
synchronized (this.lock)
{
return this.getDelegate().aggregateInPlaceBy(groupBy, zeroValueFactory, mutatingAggregator);
}
}
public <K2, V2> MutableMap<K2, V2> aggregateBy(
Function<? super V, ? extends K2> groupBy,
Function0<? extends V2> zeroValueFactory,
Function2<? super V2, ? super V, ? extends V2> nonMutatingAggregator)
{
synchronized (this.lock)
{
return this.getDelegate().aggregateBy(groupBy, zeroValueFactory, nonMutatingAggregator);
}
}
public MutableMap<V, K> flipUniqueValues()
{
synchronized (this.lock)
{
return this.getDelegate().flipUniqueValues();
}
}
public MutableSetMultimap<V, K> flip()
{
synchronized (this.lock)
{
return this.getDelegate().flip();
}
}
public Set<K> keySet()
{
synchronized (this.lock)
{
return SynchronizedMutableSet.of(this.getDelegate().keySet(), this.lock);
}
}
public Collection<V> values()
{
synchronized (this.lock)
{
return SynchronizedMutableCollection.of(this.getDelegate().values(), this.lock);
}
}
public Set<Entry<K, V>> entrySet()
{
synchronized (this.lock)
{
return SynchronizedMutableSet.of(this.getDelegate().entrySet(), this.lock);
}
}
public RichIterable<K> keysView()
{
return LazyIterate.adapt(this.keySet());
}
public RichIterable<V> valuesView()
{
return LazyIterate.adapt(this.values());
}
public MutableMap<K, V> asUnmodifiable()
{
synchronized (this.lock)
{
return UnmodifiableMutableMap.of(this);
}
}
public MutableMap<K, V> asSynchronized()
{
return this;
}
public ImmutableMap<K, V> toImmutable()
{
synchronized (this.lock)
{
return Maps.immutable.withAll(this);
}
}
}