1 /* 2 * Copyright (C) 2014 The Dagger Authors. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package dagger.internal; 18 19 import static dagger.internal.DaggerCollections.newLinkedHashMapWithExpectedSize; 20 import static dagger.internal.Providers.asDaggerProvider; 21 22 import dagger.Lazy; 23 import java.util.Collections; 24 import java.util.Map; 25 26 /** 27 * A {@link Factory} implementation used to implement {@link Map} bindings. This factory returns a 28 * {@code Map<K, Provider<V>>} when calling {@link #get} (as specified by {@link Factory}). 29 */ 30 public final class MapProviderFactory<K, V> extends AbstractMapFactory<K, V, Provider<V>> 31 implements Lazy<Map<K, Provider<V>>> { 32 33 /** Returns a new {@link Builder} */ builder(int size)34 public static <K, V> Builder<K, V> builder(int size) { 35 return new Builder<>(size); 36 } 37 MapProviderFactory(Map<K, Provider<V>> contributingMap)38 private MapProviderFactory(Map<K, Provider<V>> contributingMap) { 39 super(contributingMap); 40 } 41 42 /** 43 * Returns a {@code Map<K, Provider<V>>} whose iteration order is that of the elements given by 44 * each of the providers, which are invoked in the order given at creation. 45 */ 46 @Override get()47 public Map<K, Provider<V>> get() { 48 return contributingMap(); 49 } 50 51 /** A builder for {@link MapProviderFactory}. */ 52 public static final class Builder<K, V> extends AbstractMapFactory.Builder<K, V, Provider<V>> { Builder(int size)53 private Builder(int size) { 54 super(size); 55 } 56 57 @Override put(K key, Provider<V> providerOfValue)58 public Builder<K, V> put(K key, Provider<V> providerOfValue) { 59 super.put(key, providerOfValue); 60 return this; 61 } 62 63 /** 64 * Legacy javax version of the method to support libraries compiled with an older version of 65 * Dagger. Do not use directly. 66 */ 67 @Deprecated put(K key, javax.inject.Provider<V> providerOfValue)68 public Builder<K, V> put(K key, javax.inject.Provider<V> providerOfValue) { 69 return put(key, asDaggerProvider(providerOfValue)); 70 } 71 72 @Override putAll(Provider<Map<K, Provider<V>>> mapProviderFactory)73 public Builder<K, V> putAll(Provider<Map<K, Provider<V>>> mapProviderFactory) { 74 super.putAll(mapProviderFactory); 75 return this; 76 } 77 78 /** 79 * Legacy javax version of the method to support libraries compiled with an older version of 80 * Dagger. Do not use directly. 81 */ 82 @Deprecated putAll( final javax.inject.Provider<Map<K, javax.inject.Provider<V>>> mapProviderFactory)83 public Builder<K, V> putAll( 84 final javax.inject.Provider<Map<K, javax.inject.Provider<V>>> mapProviderFactory) { 85 return putAll(new Provider<Map<K, Provider<V>>>() { 86 @Override public Map<K, Provider<V>> get() { 87 Map<K, javax.inject.Provider<V>> javaxMap = mapProviderFactory.get(); 88 if (javaxMap.isEmpty()) { 89 return Collections.emptyMap(); 90 } 91 Map<K, Provider<V>> daggerMap = newLinkedHashMapWithExpectedSize(javaxMap.size()); 92 for (Map.Entry<K, javax.inject.Provider<V>> e : javaxMap.entrySet()) { 93 daggerMap.put(e.getKey(), asDaggerProvider(e.getValue())); 94 } 95 return Collections.unmodifiableMap(daggerMap); 96 } 97 }); 98 } 99 100 /** Returns a new {@link MapProviderFactory}. */ build()101 public MapProviderFactory<K, V> build() { 102 return new MapProviderFactory<>(map); 103 } 104 } 105 } 106