com.gs.collections.impl.multimap.bag.strategy.HashBagMultimapWithHashingStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs-collections Show documentation
GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.
There is a newer version: 7.0.3
Show newest version
/*
 * Copyright 2014 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.multimap.bag.strategy;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import com.gs.collections.api.bag.MutableBag;
import com.gs.collections.api.block.HashingStrategy;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.map.MutableMap;
import com.gs.collections.api.multimap.Multimap;
import com.gs.collections.api.multimap.bag.MutableBagMultimap;
import com.gs.collections.api.tuple.Pair;
import com.gs.collections.impl.bag.mutable.HashBag;
import com.gs.collections.impl.map.strategy.mutable.UnifiedMapWithHashingStrategy;
import com.gs.collections.impl.multimap.bag.AbstractMutableBagMultimap;
import com.gs.collections.impl.utility.Iterate;

public final class HashBagMultimapWithHashingStrategy
        extends AbstractMutableBagMultimap implements Externalizable
{
    private static final long serialVersionUID = 1L;
    private HashingStrategy hashingStrategy;

    /**
     * @deprecated Empty default constructor used for serialization. Instantiating an HashBagMultimapWithHashingStrategy with
     * this constructor will have a null multimapHashingStrategy, and throw NullPointerException when used.
     */
    @SuppressWarnings("UnusedDeclaration")
    @Deprecated
    public HashBagMultimapWithHashingStrategy()
    {
        // For Externalizable use only
    }

    public HashBagMultimapWithHashingStrategy(HashingStrategy hashingStrategy)
    {
        this.hashingStrategy = hashingStrategy;
        this.map = this.createMap();
    }

    public HashBagMultimapWithHashingStrategy(HashBagMultimapWithHashingStrategy multimap)
    {
        this(multimap.hashingStrategy, multimap);
    }

    public HashBagMultimapWithHashingStrategy(HashingStrategy hashingStrategy, Multimap multimap)
    {
        this.hashingStrategy = hashingStrategy;
        this.map = this.createMapWithKeyCount(Math.max(multimap.sizeDistinct() * 2, 16));
        this.putAll(multimap);
    }

    public HashBagMultimapWithHashingStrategy(HashingStrategy hashingStrategy, Pair... pairs)
    {
        this(hashingStrategy);
        this.putAllPairs(pairs);
    }

    public HashBagMultimapWithHashingStrategy(HashingStrategy hashingStrategy, Iterable> inputIterable)
    {
        this(hashingStrategy);
        for (Pair single : inputIterable)
        {
            this.add(single);
        }
    }

    public static  HashBagMultimapWithHashingStrategy newMultimap(HashBagMultimapWithHashingStrategy multimap)
    {
        return new HashBagMultimapWithHashingStrategy(multimap);
    }

    public static  HashBagMultimapWithHashingStrategy newMultimap(HashingStrategy multimapHashingStrategy, Multimap multimap)
    {
        return new HashBagMultimapWithHashingStrategy(multimapHashingStrategy, multimap);
    }

    public static  HashBagMultimapWithHashingStrategy newMultimap(HashingStrategy multimapHashingStrategy)
    {
        return new HashBagMultimapWithHashingStrategy(multimapHashingStrategy);
    }

    @SafeVarargs
    public static  HashBagMultimapWithHashingStrategy newMultimap(HashingStrategy multimapHashingStrategy, Pair... pairs)
    {
        return new HashBagMultimapWithHashingStrategy(multimapHashingStrategy, pairs);
    }

    public static  HashBagMultimapWithHashingStrategy newMultimap(HashingStrategy multimapHashingStrategy, Iterable> inputIterable)
    {
        return new HashBagMultimapWithHashingStrategy(multimapHashingStrategy, inputIterable);
    }

    @Override
    protected MutableMap> createMap()
    {
        return UnifiedMapWithHashingStrategy.newMap(this.hashingStrategy);
    }

    @Override
    protected MutableMap> createMapWithKeyCount(int keyCount)
    {
        return UnifiedMapWithHashingStrategy.newMap(this.hashingStrategy, keyCount);
    }

    @Override
    protected MutableBag createCollection()
    {
        return HashBag.newBag();
    }

    public HashingStrategy getKeyHashingStrategy()
    {
        return this.hashingStrategy;
    }

    public HashBagMultimapWithHashingStrategy newEmpty()
    {
        return new HashBagMultimapWithHashingStrategy(this.hashingStrategy);
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException
    {
        out.writeObject(this.hashingStrategy);
        super.writeExternal(out);
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
    {
        this.hashingStrategy = (HashingStrategy) in.readObject();
        super.readExternal(in);
    }

    // Currently this returns a HashBagMultimap.
    // On a future release, it will return HashBagWithHashingStrategyMultimap, where the HashBag collection hashing strategy
    // will be the hashing strategy of this multimap
    public MutableBagMultimap flip()
    {
        return Iterate.flip(this);
    }

    public  HashBagMultimapWithHashingStrategy collectValues(Function function)
    {
        return this.collectValues(function, HashBagMultimapWithHashingStrategy.newMultimap(this.hashingStrategy));
    }

    public HashBagMultimapWithHashingStrategy selectKeysValues(Predicate2 predicate)
    {
        return this.selectKeysValues(predicate, this.newEmpty());
    }

    public HashBagMultimapWithHashingStrategy rejectKeysValues(Predicate2 predicate)
    {
        return this.rejectKeysValues(predicate, this.newEmpty());
    }

    public HashBagMultimapWithHashingStrategy selectKeysMultiValues(Predicate2> predicate)
    {
        return this.selectKeysMultiValues(predicate, this.newEmpty());
    }

    public HashBagMultimapWithHashingStrategy rejectKeysMultiValues(Predicate2> predicate)
    {
        return this.rejectKeysMultiValues(predicate, this.newEmpty());
    }
}