com.google.template.soy.shared.internal

Class GuiceSimpleScope

java.lang.Object

com.google.template.soy.shared.internal.GuiceSimpleScope

All Implemented Interfaces:

com.google.inject.Scope

public final class GuiceSimpleScope
extends Object
implements com.google.inject.Scope

Scopes a single execution of a block of code.

Important: Do not use outside of Soy code (treat as superpackage-private).

Apply this scope with a try/finally block:

   scope.enter();
   try (GuiceSimpleScope.InScope inScope = scope.enter()) {
     // explicitly seed some seed objects
     inScope.seed(SomeObject.class, someObject);
     // create and access scoped objects
     ...
   }
 

The scope can be initialized with one or more seed values by calling seed(key, value) or seed(class, value) before the injector will be called upon to provide for this key.

For each key seeded with seed(), you must include a corresponding binding:

   bind(key)
       .toProvider(GuiceSimpleScope.<KeyClass>getUnscopedProvider())
       .in(ScopeAnnotation.class);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GuiceSimpleScope.InScope An autoclosable object that can be used to seed and exit scopes.

Constructor Summary

Constructors

Constructor and Description
GuiceSimpleScope()

Method Summary

Modifier and Type	Method and Description
GuiceSimpleScope.InScope	enter() Enters an occurrence of this scope.
static <T> com.google.inject.Provider<T>	getUnscopedProvider() Returns a provider that always throws exception complaining that the object in question must be seeded before it can be injected.
<T> com.google.inject.Provider<T>	scope(com.google.inject.Key<T> key, com.google.inject.Provider<T> unscopedProvider)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.inject.Scope

toString

Constructor Detail

GuiceSimpleScope

public GuiceSimpleScope()

Method Detail

getUnscopedProvider

public static <T> com.google.inject.Provider<T> getUnscopedProvider()

Returns a provider that always throws exception complaining that the object in question must be seeded before it can be injected.

Returns:

typed provider

enter

@CheckReturnValue
public GuiceSimpleScope.InScope enter()

Enters an occurrence of this scope.

scope

public <T> com.google.inject.Provider<T> scope(com.google.inject.Key<T> key,
                                               com.google.inject.Provider<T> unscopedProvider)

Specified by:

scope in interface com.google.inject.Scope