Class Providers

java.lang.Object
com.google.inject.util.Providers

@CheckReturnValue public final class Providers extends Object
Static utility methods for creating and working with instances of Provider.
Since:
2.0
Author:
Kevin Bourrillion (kevinb9n@gmail.com)
  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> Provider<T>
    guicify(Provider<T> provider)
    Deprecated.
    Marked as deprecated as a hint to users that calling this is unnecessary, because the provider is already a guice Provider.
    static <T> Provider<T>
    guicify(jakarta.inject.Provider<T> provider)
    Returns a Guice-friendly com.google.inject.Provider for the given jakarta.inject.Provider.
    static <T> Provider<T>
    guicify(javax.inject.Provider<T> provider)
    Returns a Guice-friendly com.google.inject.Provider for the given JSR-330 javax.inject.Provider.
    static <T> Provider<T>
    of(T instance)
    Returns a provider which always provides instance.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • of

      public static <T> Provider<T> of(T instance)
      Returns a provider which always provides instance. This should not be necessary to use in your application, but is helpful for several types of unit tests.
      Parameters:
      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.
    • guicify

      @Deprecated public static <T> Provider<T> guicify(Provider<T> provider)
      Deprecated.
      Marked as deprecated as a hint to users that calling this is unnecessary, because the provider is already a guice Provider.
      Returns itself. This exists primarily to avoid ambiguous method reference compile errors when calling guicify with a Guice provider.
      Since:
      6.0
    • guicify

      public static <T> Provider<T> guicify(javax.inject.Provider<T> provider)
      Returns a Guice-friendly com.google.inject.Provider for the given JSR-330 javax.inject.Provider. The converse method is unnecessary, since Guice providers directly implement the JSR-330 interface.
      Since:
      3.0
    • guicify

      public static <T> Provider<T> guicify(jakarta.inject.Provider<T> provider)
      Returns a Guice-friendly com.google.inject.Provider for the given jakarta.inject.Provider. The converse method is unnecessary, since Guice providers directly implement the jakarta.inject.Provider interface.
      Since:
      6.0