Package org.elasticsearch.common.inject

Interface Scope

public interface Scope
A scope is a level of visibility that instances provided by Guice may have. By default, an instance created by the Injector has no scope, meaning it has no state from the framework's perspective -- the Injector creates it, injects it once into the class that required it, and then immediately forgets it. Associating a scope with a particular binding allows the created instance to be "remembered" and possibly used again for other injections.

An example of a scope is Scopes.SINGLETON.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> Provider<T>
    scope(Key<T> key, Provider<T> unscoped)
    Scopes a provider.
    String
    toString()
    A short but useful description of this scope.

  • Method Details

    • scope

      <T> Provider<T> scope(Key<T> key, Provider<T> unscoped)
      Scopes a provider. The returned provider returns objects from this scope. If an object does not exist in this scope, the provider can use the given unscoped provider to retrieve one.

      Scope implementations are strongly encouraged to override Object.toString() in the returned provider and include the backing provider's toString() output.

      Parameters:
      key - binding key
      unscoped - locates an instance when one doesn't already exist in this scope.
      Returns:
      a new provider which only delegates to the given unscoped provider when an instance of the requested object doesn't already exist in this scope

    • toString

      String toString()
      A short but useful description of this scope. For comparison, the standard scopes that ship with guice use the descriptions "Scopes.SINGLETON", "ServletScopes.SESSION" and "ServletScopes.REQUEST".
      Overrides:
      toString in class Object