org.javimmutable.collections.setmap.JImmutableTemplateSetMap Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2019, 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.setmap;

import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.JImmutableSet;
import org.javimmutable.collections.JImmutableSetMap;
import org.javimmutable.collections.serialization.JImmutableTemplateSetMapProxy;

import javax.annotation.Nonnull;
import java.io.Serializable;

/**
 * JImmutableSetMap implementation that uses arbitrary Map and Set templates.
 * Allows mix and match of map and set types to support all possible combinations.
 */
public class JImmutableTemplateSetMap
    extends AbstractJImmutableSetMap
    implements Serializable
{
    private static final long serialVersionUID = -121805;

    private final JImmutableMap> emptyMap;

    private JImmutableTemplateSetMap(JImmutableMap> contents,
                                     JImmutableMap> emptyMap,
                                     JImmutableSet emptySet)
    {
        super(contents, emptySet);
        this.emptyMap = emptyMap;
    }

    private JImmutableTemplateSetMap(JImmutableMap> emptyMap,
                                     JImmutableSet emptySet)
    {
        this(emptyMap, emptyMap, emptySet);
    }

    /**
     * Creates a new empty JImmutableSetMap object using the specified template map and set implementations.
     * The provided templates are always emptied before use.
     */
    public static  JImmutableSetMap of(@Nonnull JImmutableMap> emptyMap,
                                                   @Nonnull JImmutableSet emptySet)
    {
        return new JImmutableTemplateSetMap<>(emptyMap.deleteAll(), emptySet.deleteAll());
    }

    @Override
    public void checkInvariants()
    {
    }

    public JImmutableMap> getEmptyMap()
    {
        return emptyMap;
    }

    public JImmutableSet getEmptySet()
    {
        return emptySet;
    }

    @Override
    protected JImmutableSetMap create(JImmutableMap> map)
    {
        return new JImmutableTemplateSetMap<>(map, emptyMap, emptySet);
    }

    private Object writeReplace()
    {
        return new JImmutableTemplateSetMapProxy(this);
    }
}