Top Description Methods
com.google.inject

public Interface Scope

Known Direct Implementers
com.google.inject.internal.SingletonScope
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.

Author
[email protected] (Bob Lee)

Method Summary

Modifier and TypeMethod and Description
public <T> Provider<T>

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
scope(Key<T>
binding key
key, Provider<T>
locates an instance when one doesn't already exist in this scope.
unscoped)

Scopes a provider.

public String
toString()

A short but useful description of this scope.

Method Detail

scopeback to summary
public <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:Key<T>

binding key

unscoped:Provider<T>

locates an instance when one doesn't already exist in this scope.

Returns:Provider<T>

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

toStringback to summary
public 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".

Annotations
@Override