org.eclipse.collections.impl.bag.mutable.HashBag 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: 12.0.0.M3
/*
 * Copyright (c) 2018 Goldman Sachs.
 * 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.bag.mutable;

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

import org.eclipse.collections.api.bag.Bag;
import org.eclipse.collections.api.bag.MutableBag;
import org.eclipse.collections.api.block.predicate.primitive.IntPredicate;
import org.eclipse.collections.api.map.primitive.MutableObjectIntMap;
import org.eclipse.collections.impl.map.mutable.primitive.ObjectIntHashMap;
import org.eclipse.collections.impl.utility.ArrayIterate;
import org.eclipse.collections.impl.utility.Iterate;

/**
 * A HashBag is a MutableBag which uses a Map as its underlying data store. Each key in the Map represents some item,
 * and the value in the map represents the current number of occurrences of that item.
 *
 * @since 1.0
 */
public class HashBag
        extends AbstractHashBag
        implements Externalizable
{
    private static final long serialVersionUID = 1L;

    public HashBag()
    {
        this.items = ObjectIntHashMap.newMap();
    }

    public HashBag(int size)
    {
        this.items = new ObjectIntHashMap<>(size);
    }

    private HashBag(MutableObjectIntMap map)
    {
        this.items = map;
        this.size = (int) map.sum();
    }

    public static  HashBag newBag()
    {
        return new HashBag<>();
    }

    public static  HashBag newBag(int size)
    {
        return new HashBag<>(size);
    }

    public static  HashBag newBag(Bag source)
    {
        HashBag result = HashBag.newBag(source.sizeDistinct());
        result.addAllBag(source);
        return result;
    }

    public static  HashBag newBag(Iterable source)
    {
        if (source instanceof Bag)
        {
            return HashBag.newBag((Bag) source);
        }
        return HashBag.newBagWith((E[]) Iterate.toArray(source));
    }

    public static  HashBag newBagWith(E... elements)
    {
        HashBag result = HashBag.newBag();
        ArrayIterate.addAllTo(elements, result);
        return result;
    }

    @Override
    protected int computeHashCode(T item)
    {
        return item.hashCode();
    }

    @Override
    public MutableBag selectByOccurrences(IntPredicate predicate)
    {
        MutableObjectIntMap map = this.items.select((each, occurrences) -> {
            return predicate.accept(occurrences);
        });
        return new HashBag<>(map);
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException
    {
        ((Externalizable) this.items).writeExternal(out);
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
    {
        this.items = new ObjectIntHashMap<>();
        ((Externalizable) this.items).readExternal(in);
        this.size = (int) this.items.sum();
    }

    @Override
    public HashBag without(T element)
    {
        this.remove(element);
        return this;
    }

    @Override
    public MutableBag newEmpty()
    {
        return HashBag.newBag();
    }

    @Override
    public HashBag with(T element)
    {
        this.add(element);
        return this;
    }

    @Override
    public HashBag withAll(Iterable iterable)
    {
        this.addAllIterable(iterable);
        return this;
    }

    @Override
    public HashBag withoutAll(Iterable iterable)
    {
        this.removeAllIterable(iterable);
        return this;
    }

    public HashBag with(T... elements)
    {
        this.addAll(Arrays.asList(elements));
        return this;
    }

    public HashBag with(T element1, T element2)
    {
        this.add(element1);
        this.add(element2);
        return this;
    }

    public HashBag with(T element1, T element2, T element3)
    {
        this.add(element1);
        this.add(element2);
        this.add(element3);
        return this;
    }
}