org.glassfish.jersey.internal.guava.AbstractMultimap Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jersey-common Show documentation
Jersey core common packages
There is a newer version: 4.0.0-M1
/*
 * Copyright (C) 2012 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.glassfish.jersey.internal.guava;

import java.util.AbstractCollection;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import static org.glassfish.jersey.internal.guava.Preconditions.checkNotNull;

/**
 * A skeleton {@code Multimap} implementation, not necessarily in terms of a {@code Map}.
 *
 * @author Louis Wasserman
 */
abstract class AbstractMultimap implements Multimap {
    private transient Collection> entries;
    private transient Set keySet;
    private transient Collection values;
    private transient Map> asMap;

    @Override
    public boolean containsValue(Object value) {
        for (Collection collection : asMap().values()) {
            if (collection.contains(value)) {
                return true;
            }
        }

        return false;
    }

    @Override
    public boolean containsEntry(Object key, Object value) {
        Collection collection = asMap().get(key);
        return collection != null && collection.contains(value);
    }

    @Override
    public boolean remove(Object key, Object value) {
        Collection collection = asMap().get(key);
        return collection != null && collection.remove(value);
    }

    @Override
    public boolean put(K key, V value) {
        return get(key).add(value);
    }

    @Override
    public boolean putAll(K key, Iterable values) {
        checkNotNull(values);
        // make sure we only call values.iterator() once
        // and we only call get(key) if values is nonempty
        if (values instanceof Collection) {
            Collection valueCollection = (Collection) values;
            return !valueCollection.isEmpty() && get(key).addAll(valueCollection);
        } else {
            Iterator valueItr = values.iterator();
            return valueItr.hasNext() && Iterators.addAll(get(key), valueItr);
        }
    }

    @Override
    public Collection> entries() {
        Collection> result = entries;
        return (result == null) ? entries = createEntries() : result;
    }

    private Collection> createEntries() {
        if (this instanceof SetMultimap) {
            return new EntrySet();
        } else {
            return new Entries();
        }
    }

    abstract Iterator> entryIterator();

    @Override
    public Set keySet() {
        Set result = keySet;
        return (result == null) ? keySet = createKeySet() : result;
    }

    Set createKeySet() {
        return new Maps.KeySet>(asMap());
    }

    @Override
    public Collection values() {
        Collection result = values;
        return (result == null) ? values = createValues() : result;
    }

    private Collection createValues() {
        return new Values();
    }

    Iterator valueIterator() {
        return Maps.valueIterator(entries().iterator());
    }

    @Override
    public Map> asMap() {
        Map> result = asMap;
        return (result == null) ? asMap = createAsMap() : result;
    }

    abstract Map> createAsMap();

    @Override
    public boolean equals(Object object) {
        return Multimaps.equalsImpl(this, object);
    }

    /**
     * Returns the hash code for this multimap.
     * 
     * The hash code of a multimap is defined as the hash code of the map view,
     * as returned by {@link Multimap#asMap}.
     *
     * @see Map#hashCode
     */
    @Override
    public int hashCode() {
        return asMap().hashCode();
    }

    /**
     * Returns a string representation of the multimap, generated by calling
     * {@code toString} on the map returned by {@link Multimap#asMap}.
     *
     * @return a string representation of the multimap
     */
    @Override
    public String toString() {
        return asMap().toString();
    }

    // Comparison and hashing

    private class Entries extends Multimaps.Entries {
        @Override
        Multimap multimap() {
            return AbstractMultimap.this;
        }

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

    private class EntrySet extends Entries implements Set> {
        @Override
        public int hashCode() {
            return Sets.hashCodeImpl(this);
        }

        @Override
        public boolean equals(Object obj) {
            return Sets.equalsImpl(this, obj);
        }
    }

    private class Values extends AbstractCollection {
        @Override
        public Iterator iterator() {
            return valueIterator();
        }

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

        @Override
        public boolean contains(Object o) {
            return AbstractMultimap.this.containsValue(o);
        }

        @Override
        public void clear() {
            AbstractMultimap.this.clear();
        }
    }
}