11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2007 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.collect; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.GwtCompatible; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.base.Objects; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Collection; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Iterator; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Map; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Set; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport javax.annotation.Nullable; 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A map which forwards all its method calls to another map. Subclasses should 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * override one or more methods to modify the behavior of the backing map as 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * desired per the <a 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>. 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p><i>Warning:</i> The methods of {@code ForwardingMap} forward 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <i>indiscriminately</i> to the methods of the delegate. For example, 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * overriding {@link #put} alone <i>will not</i> change the behavior of {@link 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * #putAll}, which can lead to unexpected behavior. In this case, you should 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * override {@code putAll} as well, either providing your own implementation, or 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * delegating to the provided {@code standardPutAll} method. 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p>Each of the {@code standard} methods, where appropriate, use {@link 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Objects#equal} to test equality for both keys and values. This may not be 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * the desired behavior for map implementations that use non-standard notions of 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * key equality, such as a {@code SortedMap} whose comparator is not consistent 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * with {@code equals}. 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p>The {@code standard} methods and the collection views they return are not 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * guaranteed to be thread-safe, even when all of the methods that they depend 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * on are thread-safe. 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Kevin Bourrillion 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Jared Levy 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Louis Wasserman 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 2.0 (imported from Google Collections Library) 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@GwtCompatible 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic abstract class ForwardingMap<K, V> extends ForwardingObject 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert implements Map<K, V> { 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // TODO(user): identify places where thread safety is actually lost 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** Constructor for use by subclasses. */ 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected ForwardingMap() {} 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override protected abstract Map<K, V> delegate(); 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public int size() { 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().size(); 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public boolean isEmpty() { 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().isEmpty(); 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public V remove(Object object) { 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().remove(object); 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void clear() { 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert delegate().clear(); 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public boolean containsKey(Object key) { 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().containsKey(key); 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public boolean containsValue(Object value) { 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().containsValue(value); 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public V get(Object key) { 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().get(key); 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public V put(K key, V value) { 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().put(key, value); 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void putAll(Map<? extends K, ? extends V> map) { 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert delegate().putAll(map); 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public Set<K> keySet() { 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().keySet(); 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public Collection<V> values() { 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().values(); 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public Set<Entry<K, V>> entrySet() { 1251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().entrySet(); 1261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean equals(@Nullable Object object) { 1291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return object == this || delegate().equals(object); 1301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public int hashCode() { 1331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return delegate().hashCode(); 1341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #putAll(Map)} in terms of {@link 1381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * #put(Object, Object)}. If you override {@link #put(Object, Object)}, you 1391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * may wish to override {@link #putAll(Map)} to forward to this 1401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * implementation. 1411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 1421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 1431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected void standardPutAll(Map<? extends K, ? extends V> map) { 1451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Maps.putAllImpl(this, map); 1461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible, albeit inefficient, definition of {@link #remove} in terms of 1501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * the {@code iterator} method of {@link #entrySet}. If you override {@link 1511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * #entrySet}, you may wish to override {@link #remove} to forward to this 1521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * implementation. 1531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 1541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p>Alternately, you may wish to override {@link #remove} with {@code 1551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * keySet().remove}, assuming that approach would not lead to an infinite 1561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * loop. 1571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 1581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 1591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected V standardRemove(@Nullable Object key) { 1611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Iterator<Entry<K, V>> entryIterator = entrySet().iterator(); 1621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert while (entryIterator.hasNext()) { 1631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Entry<K, V> entry = entryIterator.next(); 1641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (Objects.equal(entry.getKey(), key)) { 1651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert V value = entry.getValue(); 1661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert entryIterator.remove(); 1671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return value; 1681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return null; 1711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #clear} in terms of the {@code iterator} 1751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * method of {@link #entrySet}. In many cases, you may wish to override 1761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link #clear} to forward to this implementation. 1771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 1781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 1791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected void standardClear() { 1811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Iterator<Entry<K, V>> entryIterator = entrySet().iterator(); 1821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert while (entryIterator.hasNext()) { 1831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert entryIterator.next(); 1841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert entryIterator.remove(); 1851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible implementation of {@link Map#keySet} in terms of the following 1901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * methods: {@link ForwardingMap#clear}, {@link ForwardingMap#containsKey}, 1911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link ForwardingMap#isEmpty}, {@link ForwardingMap#remove}, {@link 1921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * ForwardingMap#size}, and the {@link Set#iterator} method of {@link 1931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * ForwardingMap#entrySet}. In many cases, you may wish to override {@link 1941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * ForwardingMap#keySet} to forward to this implementation or a subclass 1951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * thereof. 1961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 1971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 10.0 1981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta 2001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected class StandardKeySet extends Maps.KeySet<K, V> { 2011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public StandardKeySet() {} 2021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 2041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Map<K, V> map() { 2051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return ForwardingMap.this; 2061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible, albeit inefficient, definition of {@link #containsKey} in terms 2111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * of the {@code iterator} method of {@link #entrySet}. If you override {@link 2121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * #entrySet}, you may wish to override {@link #containsKey} to forward to 2131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * this implementation. 2141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 2161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected boolean standardContainsKey(@Nullable Object key) { 2181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Maps.containsKeyImpl(this, key); 2191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible implementation of {@link Map#values} in terms of the following 2231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * methods: {@link ForwardingMap#clear}, {@link ForwardingMap#containsValue}, 2241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link ForwardingMap#isEmpty}, {@link ForwardingMap#size}, and the {@link 2251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Set#iterator} method of {@link ForwardingMap#entrySet}. In many cases, you 2261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * may wish to override {@link ForwardingMap#values} to forward to this 2271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * implementation or a subclass thereof. 2281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 10.0 2301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta 2321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected class StandardValues extends Maps.Values<K, V> { 2331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public StandardValues() {} 2341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 2361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Map<K, V> map() { 2371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return ForwardingMap.this; 2381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #containsValue} in terms of the {@code 2431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * iterator} method of {@link #entrySet}. If you override {@link #entrySet}, 2441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may wish to override {@link #containsValue} to forward to this 2451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * implementation. 2461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 2481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected boolean standardContainsValue(@Nullable Object value) { 2501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Maps.containsValueImpl(this, value); 2511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible implementation of {@link Map#entrySet} in terms of the following 2551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * methods: {@link ForwardingMap#clear}, {@link ForwardingMap#containsKey}, 2561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link ForwardingMap#get}, {@link ForwardingMap#isEmpty}, {@link 2571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * ForwardingMap#remove}, and {@link ForwardingMap#size}. In many cases, you 2581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * may wish to override {@link #entrySet} to forward to this implementation 2591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * or a subclass thereof. 2601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 10.0 2621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta 2641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected abstract class StandardEntrySet extends Maps.EntrySet<K, V> { 2651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public StandardEntrySet() {} 2661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 2681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Map<K, V> map() { 2691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return ForwardingMap.this; 2701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #isEmpty} in terms of the {@code iterator} 2751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * method of {@link #entrySet}. If you override {@link #entrySet}, you may 2761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * wish to override {@link #isEmpty} to forward to this implementation. 2771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 2791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected boolean standardIsEmpty() { 2811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return !entrySet().iterator().hasNext(); 2821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #equals} in terms of the {@code equals} 2861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * method of {@link #entrySet}. If you override {@link #entrySet}, you may 2871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * wish to override {@link #equals} to forward to this implementation. 2881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 2891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 2901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 2911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected boolean standardEquals(@Nullable Object object) { 2921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Maps.equalsImpl(this, object); 2931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 2951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 2961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #hashCode} in terms of the {@code iterator} 2971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * method of {@link #entrySet}. If you override {@link #entrySet}, you may 2981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * wish to override {@link #hashCode} to forward to this implementation. 2991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 3001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 3011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 3021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected int standardHashCode() { 3031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Sets.hashCodeImpl(entrySet()); 3041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 3051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 3061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 3071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A sensible definition of {@link #toString} in terms of the {@code iterator} 3081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * method of {@link #entrySet}. If you override {@link #entrySet}, you may 3091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * wish to override {@link #toString} to forward to this implementation. 3101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 3111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 3121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 3131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Beta protected String standardToString() { 3141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Maps.toStringImpl(this); 3151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 3161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 317