com.google.inject.util.Providers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of standalone-sisu-uber Show documentation
There is a newer version: 3.0.0-alpha-3
/*
 * Copyright (C) 2007 Google Inc.
 *
 * 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 com.google.inject.util;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.ImmutableSet.toImmutableSet;

import com.google.common.base.Objects;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.errorprone.annotations.CheckReturnValue;
import com.google.inject.Inject;
import com.google.inject.Injector;
import com.google.inject.Provider;
import com.google.inject.spi.Dependency;
import com.google.inject.spi.InjectionPoint;
import com.google.inject.spi.ProviderWithDependencies;
import java.util.Set;

/**
 * Static utility methods for creating and working with instances of {@link Provider}.
 *
 * @author Kevin Bourrillion ([email protected])
 * @since 2.0
 */
@CheckReturnValue
public final class Providers {

  private Providers() {}

  /**
   * Returns a provider which always provides {@code instance}. This should not be necessary to use
   * in your application, but is helpful for several types of unit tests.
   *
   * @param instance the instance that should always be provided. This is also permitted to be null,
   *     to enable aggressive testing, although in real life a Guice-supplied Provider will never
   *     return null.
   */
  public static  Provider of(final T instance) {
    return new ConstantProvider(instance);
  }

  private static final class ConstantProvider implements Provider {
    private final T instance;

    private ConstantProvider(T instance) {
      this.instance = instance;
    }

    @Override
    public T get() {
      return instance;
    }

    @Override
    public String toString() {
      return "of(" + instance + ")";
    }

    @Override
    public boolean equals(Object obj) {
      return (obj instanceof ConstantProvider)
          && Objects.equal(instance, ((ConstantProvider) obj).instance);
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(instance);
    }
  }

  /**
   * Returns itself. This exists primarily to avoid ambiguous method reference compile errors when
   * calling guicify with a Guice provider.
   *
   * @since 6.0
   * @deprecated Marked as deprecated as a hint to users that calling this is unnecessary, because
   *     the provider is already a guice Provider.
   */
  @Deprecated
  public static  Provider guicify(Provider provider) {
    return provider;
  }

  /**
   * Returns a Guice-friendly {@code com.google.inject.Provider} for the given JSR-330 {@code
   * javax.inject.Provider}. The converse method is unnecessary, since Guice providers directly
   * implement the JSR-330 interface.
   *
   * @since 3.0
   */
  public static  Provider guicify(javax.inject.Provider provider) {
    if (provider instanceof Provider) {
      return (Provider) provider;
    }

    final javax.inject.Provider delegate = checkNotNull(provider, "provider");

    // Ensure that we inject all injection points from the delegate provider.
    Set injectionPoints =
        InjectionPoint.forInstanceMethodsAndFields(provider.getClass());
    if (injectionPoints.isEmpty()) {
      return new GuicifiedJSR330Provider(delegate);
    } else {
      Set> mutableDeps = Sets.newHashSet();
      for (InjectionPoint ip : injectionPoints) {
        mutableDeps.addAll(ip.getDependencies());
      }
      final Set> dependencies = ImmutableSet.copyOf(mutableDeps);
      return new GuicifiedJSR330ProviderWithDependencies(dependencies, delegate);
    }
  }

  /**
   * Returns a Guice-friendly {@code com.google.inject.Provider} for the given {@code
   * jakarta.inject.Provider}. The converse method is unnecessary, since Guice providers directly
   * implement the jakarta.inject.Provider interface.
   *
   * @since 6.0
   */
  public static  Provider guicify(jakarta.inject.Provider provider) {
    if (provider instanceof Provider) {
      return (Provider) provider;
    }

    jakarta.inject.Provider delegate = checkNotNull(provider, "provider");

    // Ensure that we inject all injection points from the delegate provider.
    Set injectionPoints =
        InjectionPoint.forInstanceMethodsAndFields(provider.getClass());
    if (injectionPoints.isEmpty()) {
      return new GuicifiedJakartaProvider(delegate);
    } else {
      ImmutableSet> dependencies =
          injectionPoints.stream()
              .flatMap(ip -> ip.getDependencies().stream())
              .collect(toImmutableSet());
      return new GuicifiedJakartaProviderWithDependencies(dependencies, delegate);
    }
  }

  private static class GuicifiedJSR330Provider implements Provider {
    protected final javax.inject.Provider delegate;

    private GuicifiedJSR330Provider(javax.inject.Provider delegate) {
      this.delegate = delegate;
    }

    @Override
    public T get() {
      return delegate.get();
    }

    @Override
    public String toString() {
      return "guicified(" + delegate + ")";
    }

    @Override
    public boolean equals(Object obj) {
      return (obj instanceof GuicifiedJSR330Provider)
          && Objects.equal(delegate, ((GuicifiedJSR330Provider) obj).delegate);
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(delegate);
    }
  }

  private static class GuicifiedJakartaProvider implements Provider {
    protected final jakarta.inject.Provider delegate;

    private GuicifiedJakartaProvider(jakarta.inject.Provider delegate) {
      this.delegate = delegate;
    }

    @Override
    public T get() {
      return delegate.get();
    }

    @Override
    public String toString() {
      return "guicified(" + delegate + ")";
    }

    @Override
    public boolean equals(Object obj) {
      return (obj instanceof GuicifiedJakartaProvider)
          && Objects.equal(delegate, ((GuicifiedJakartaProvider) obj).delegate);
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(delegate);
    }
  }

  private static final class GuicifiedJSR330ProviderWithDependencies
      extends GuicifiedJSR330Provider implements ProviderWithDependencies {
    private final Set> dependencies;

    private GuicifiedJSR330ProviderWithDependencies(
        Set> dependencies, javax.inject.Provider delegate) {
      super(delegate);
      this.dependencies = dependencies;
    }

    @SuppressWarnings("unused")
    @Inject
    void initialize(Injector injector) {
      injector.injectMembers(delegate);
    }

    @Override
    public Set> getDependencies() {
      return dependencies;
    }
  }

  private static final class GuicifiedJakartaProviderWithDependencies
      extends GuicifiedJakartaProvider implements ProviderWithDependencies {
    private final Set> dependencies;

    private GuicifiedJakartaProviderWithDependencies(
        Set> dependencies, jakarta.inject.Provider delegate) {
      super(delegate);
      this.dependencies = dependencies;
    }

    @SuppressWarnings("unused")
    @Inject
    void initialize(Injector injector) {
      injector.injectMembers(delegate);
    }

    @Override
    public Set> getDependencies() {
      return dependencies;
    }
  }
}