org.eclipse.collections.impl.multimap.AbstractImmutableMultimap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections Show documentation
There is a newer version: 11.1.0-r13
/*
 * Copyright (c) 2022 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.impl.multimap;

import java.io.InvalidClassException;
import java.io.ObjectStreamException;
import java.util.Collection;

import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.collection.ImmutableCollection;
import org.eclipse.collections.api.factory.Maps;
import org.eclipse.collections.api.map.ImmutableMap;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.multimap.ImmutableMultimap;
import org.eclipse.collections.api.set.SetIterable;
import org.eclipse.collections.impl.set.mutable.UnmodifiableMutableSet;
import org.eclipse.collections.impl.utility.Iterate;

public abstract class AbstractImmutableMultimap>
        extends AbstractMultimap
        implements ImmutableMultimap
{
    protected final ImmutableMap map;

    /**
     * Creates a new multimap that clones the provided map into an ImmutableMap.
     *
     * @param map place to store the mapping from each key to its corresponding values
     */
    protected AbstractImmutableMultimap(MutableMap map)
    {
        this(map.toImmutable());
    }

    /**
     * Creates a new multimap that uses the provided immutableMap.
     *
     * @param immutableMap place to store the mapping from each key to its corresponding values
     */
    protected AbstractImmutableMultimap(ImmutableMap immutableMap)
    {
        this.map = immutableMap;
    }

    @Override
    protected ImmutableMap getMap()
    {
        return this.map;
    }

    // Query Operations

    @Override
    public int size()
    {
        class CountProcedure implements Procedure
        {
            private static final long serialVersionUID = 1L;

            private int totalSize;

            @Override
            public void value(C collection)
            {
                this.totalSize += collection.size();
            }

            public int getTotalSize()
            {
                return this.totalSize;
            }
        }

        CountProcedure procedure = new CountProcedure();
        this.map.forEachValue(procedure);
        return procedure.getTotalSize();
    }

    @Override
    public int sizeDistinct()
    {
        return this.map.size();
    }

    @Override
    public boolean isEmpty()
    {
        return this.map.isEmpty();
    }

    // Views

    @Override
    public SetIterable keySet()
    {
        return UnmodifiableMutableSet.of(this.getMap().castToMap().keySet());
    }

    @Override
    public C get(K key)
    {
        return this.map.getIfAbsentWith(key, this.createCollectionBlock(), this);
    }

    @Override
    public MutableMap> toMap()
    {
        return (MutableMap>) (MutableMap) this.map.toMap();
    }

    @Override
    public > MutableMap toMap(Function0 collectionFactory)
    {
        MutableMap result = Maps.mutable.empty();
        this.map.forEachKeyValue((key, iterable) -> {
            R newCollection = collectionFactory.value();
            Iterate.addAllTo(iterable, newCollection);
            result.put(key, newCollection);
        });

        return result;
    }

    @Override
    public ImmutableMultimap toImmutable()
    {
        return this;
    }

    protected Object readResolve() throws ObjectStreamException
    {
        throw new InvalidClassException("You should be using the proxy for serialization of ImmutableMultimaps");
    }
}