dagger.internal.MapProviderFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dagger Show documentation
A fast dependency injector for Android and Java.
There is a newer version: 2.52
/*
 * Copyright (C) 2014 The Dagger 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 dagger.internal;

import static dagger.internal.DaggerCollections.newLinkedHashMapWithExpectedSize;
import static dagger.internal.Providers.asDaggerProvider;

import dagger.Lazy;
import java.util.Collections;
import java.util.Map;

/**
 * A {@link Factory} implementation used to implement {@link Map} bindings. This factory returns a
 * {@code Map>} when calling {@link #get} (as specified by {@link Factory}).
 */
public final class MapProviderFactory extends AbstractMapFactory>
    implements Lazy>> {

  /** Returns a new {@link Builder} */
  public static  Builder builder(int size) {
    return new Builder<>(size);
  }

  private MapProviderFactory(Map> contributingMap) {
    super(contributingMap);
  }

  /**
   * Returns a {@code Map>} whose iteration order is that of the elements given by
   * each of the providers, which are invoked in the order given at creation.
   */
  @Override
  public Map> get() {
    return contributingMap();
  }

  /** A builder for {@link MapProviderFactory}. */
  public static final class Builder extends AbstractMapFactory.Builder> {
    private Builder(int size) {
      super(size);
    }

    @Override
    public Builder put(K key, Provider providerOfValue) {
      super.put(key, providerOfValue);
      return this;
    }

    /**
     * Legacy javax version of the method to support libraries compiled with an older version of
     * Dagger. Do not use directly.
     */
    @Deprecated
    public Builder put(K key, javax.inject.Provider providerOfValue) {
      return put(key, asDaggerProvider(providerOfValue));
    }

    @Override
    public Builder putAll(Provider>> mapProviderFactory) {
      super.putAll(mapProviderFactory);
      return this;
    }

    /**
     * Legacy javax version of the method to support libraries compiled with an older version of
     * Dagger. Do not use directly.
     */
    @Deprecated
    public Builder putAll(
        final javax.inject.Provider>> mapProviderFactory) {
      return putAll(new Provider>>() {
          @Override public Map> get() {
            Map> javaxMap = mapProviderFactory.get();
            if (javaxMap.isEmpty()) {
              return Collections.emptyMap();
            }
            Map> daggerMap = newLinkedHashMapWithExpectedSize(javaxMap.size());
            for (Map.Entry> e : javaxMap.entrySet()) {
              daggerMap.put(e.getKey(), asDaggerProvider(e.getValue()));
            }
            return Collections.unmodifiableMap(daggerMap);
          }
      });
    }

    /** Returns a new {@link MapProviderFactory}. */
    public MapProviderFactory build() {
      return new MapProviderFactory<>(map);
    }
  }
}