org.javimmutable.collections.tree.JImmutableTreeMultiset Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javimmutable-collections Show documentation

Library providing immutable/persistent collection classes for Java. While collections are immutable they provide methods for adding and removing values by creating new modified copies of themselves. Each copy shares almost all of its structure with other copies to minimize memory consumption.

There is a newer version: 3.2.1

Show newest version

///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2018, Burton Computer Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//     Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//     Neither the name of the Burton Computer Corporation nor the names
//     of its contributors may be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.javimmutable.collections.tree;

import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.common.AbstractJImmutableMultiset;
import org.javimmutable.collections.serialization.JImmutableTreeMultisetProxy;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import java.io.Serializable;
import java.util.Comparator;
import java.util.Map;
import java.util.TreeMap;

@Immutable
public class JImmutableTreeMultiset
    extends AbstractJImmutableMultiset
    implements Serializable
{
    @SuppressWarnings("unchecked")
    private static final JImmutableTreeMultiset EMPTY = new JImmutableTreeMultiset(new ComparableComparator());

    private final Comparator comparator;

    private JImmutableTreeMultiset(Comparator comparator)
    {
        this(JImmutableTreeMap.of(comparator), 0, comparator);
    }

    private JImmutableTreeMultiset(JImmutableMap map,
                                   int occurrences,
                                   Comparator comparator)
    {
        super(map, occurrences);
        this.comparator = comparator;
    }

    @Nonnull
    @Override
    public JImmutableTreeMultiset deleteAll()
    {
        return of(comparator);
    }

    public Comparator getComparator()
    {
        return comparator;
    }

    @SuppressWarnings("unchecked")
    public static > JImmutableTreeMultiset of()
    {
        return EMPTY;
    }

    public static  JImmutableTreeMultiset of(Comparator comparator)
    {
        return new JImmutableTreeMultiset<>(comparator);
    }

    @Override
    protected JImmutableTreeMultiset create(JImmutableMap map,
                                               int occurrences)
    {
        return new JImmutableTreeMultiset<>(map, occurrences, comparator);
    }

    @Override
    protected Map emptyMutableMap()
    {
        return new TreeMap<>(comparator);
    }

    JImmutableMap getMap()
    {
        return map;
    }
    
    private Object writeReplace()
    {
        return new JImmutableTreeMultisetProxy(this);
    }
}