pascal.taie.util.collection.AbstractTwoKeyMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e is distributed in the hope that it will be useful,but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.util.collection;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.StringJoiner;

public abstract class AbstractTwoKeyMap implements
        TwoKeyMap, Serializable {

    protected static final String NULL_KEY = "TwoKeyMap does not permit null keys";

    protected static final String NULL_VALUE = "TwoKeyMap does not permit null values";

    @Override
    public boolean containsKey(K1 key1, K2 key2) {
        return get(key1, key2) != null;
    }

    @Override
    public boolean containsKey(K1 key1) {
        return get(key1) != null;
    }

    @Override
    public boolean containsValue(V value) {
        for (K1 key1 : keySet()) {
            //noinspection ConstantConditions
            if (get(key1).containsValue(value)) {
                return true;
            }
        }
        return false;
    }

    @Override
    @Nullable
    public V get(K1 key1, K2 key2) {
        Map map = get(key1);
        return map == null ? null : map.get(key2);
    }

    /**
     * The cache of {@link AbstractTwoKeyMap#entrySet()}.
     */
    private transient Set> entrySet;

    @Override
    public Set> entrySet() {
        var es = entrySet;
        if (es == null) {
            es = Collections.unmodifiableSet(new EntrySet());
            entrySet = es;
        }
        return es;
    }

    private final class EntrySet extends AbstractSet> {

        @Override
        public boolean contains(Object o) {
            if (o instanceof Entry entry) {
                //noinspection unchecked
                V v = AbstractTwoKeyMap.this.get(
                        (K1) entry.key1(), (K2) entry.key2());
                return Objects.equals(entry.value(), v);
            }
            return false;
        }

        @Override
        @Nonnull
        public Iterator> iterator() {
            return entryIterator();
        }

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

    protected abstract Iterator> entryIterator();

    /**
     * The cache of {@link AbstractTwoKeyMap#twoKeySet()}.
     */
    private transient Set> twoKeySet;

    @Override
    public Set> twoKeySet() {
        Set> set = twoKeySet;
        if (set == null) {
            set = Views.toMappedSet(entrySet(),
                    e -> new Pair<>(e.key1(), e.key2()),
                    o -> {
                        if (o instanceof Pair pair) {
                            //noinspection unchecked
                            return containsKey((K1) pair.first(), (K2) pair.second());
                        }
                        return false;
                    });
            twoKeySet = set;
        }
        return set;
    }

    /**
     * The cache of {@link AbstractTwoKeyMap#values()}.
     */
    private transient Collection values;

    @Override
    public Collection values() {
        Collection vals = values;
        if (vals == null) {
            //noinspection unchecked
            vals = Views.toMappedCollection(entrySet(), Entry::value,
                    o -> containsValue((V) o));
            values = vals;
        }
        return vals;
    }

    @Override
    public boolean isEmpty() {
        return size() == 0;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof TwoKeyMap)) {
            return false;
        }
        @SuppressWarnings("unchecked")
        var that = (TwoKeyMap) o;
        if (size() != that.size()) {
            return false;
        }
        try {
            for (var e : entrySet()) {
                K1 key1 = e.key1();
                K2 key2 = e.key2();
                V value = e.value();
                if (!Objects.equals(value, that.get(key1, key2))) {
                    return false;
                }
            }
        } catch (ClassCastException | NullPointerException unused) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        StringJoiner joiner = new StringJoiner(", ", "{", "}");
        for (var e : entrySet()) {
            K1 key1 = e.key1();
            K2 key2 = e.key2();
            V value = e.value();
            joiner.add(key1 + "," + key2 + "=" + value);
        }
        return joiner.toString();
    }
}