GuiceSimpleScope (Closure Templates)

java.lang.Object
- com.google.template.soy.shared.internal.GuiceSimpleScope

All Implemented Interfaces:

com.google.inject.Scope
```
public 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 {
     // explicitly seed some seed objects
     scope.seed(SomeObject.class, someObject);
     // create and access scoped objects
     ...
   } finally {
     scope.exit();
   }
 
```
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

static interface GuiceSimpleScope.WithScope

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GuiceSimpleScope.WithScope`

Constructor Summary

Constructors
Constructor and Description

GuiceSimpleScope()

Constructors
Constructor and Description
`GuiceSimpleScope()`

Method Summary

Methods
Modifier and Type	Method and Description
`GuiceSimpleScope.WithScope`	`enter()` Enters an occurrence of this scope.
`void`	`exit()` Exits the current occurrence of this scope.
`<T> T`	`getForTesting(com.google.inject.Key<T> key)` Gets a value in the current 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.
`boolean`	`isActive()` Whether we're currently in an occurrence of this scope.
`<T> com.google.inject.Provider<T>`	`scope(com.google.inject.Key<T> key, com.google.inject.Provider<T> unscopedProvider)`
`<T> void`	`seed(Class<T> class0, T value)` Seeds a value in the current occurrence of this scope.
`<T> void`	`seed(com.google.inject.Key<T> key, T value)` Seeds a value in the current occurrence of this scope.

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.WithScope enter()
```
    Enters an occurrence of this scope.
  - exit
```
public void exit()
```
    Exits the current occurrence of this scope.
  - isActive
```
public boolean isActive()
```
    Whether we're currently in an occurrence of this scope.
  - seed
```
public <T> void seed(com.google.inject.Key<T> key,
            T value)
```
    Seeds a value in the current occurrence of this scope.
    
    Parameters:
    key - The key to seed.
    value - The value for the key.
  - seed
```
public <T> void seed(Class<T> class0,
            T value)
```
    Seeds a value in the current occurrence of this scope.
    
    Parameters:
    class0 - The class to seed.
    value - The value for the key.
  - getForTesting
```
public <T> T getForTesting(com.google.inject.Key<T> key)
```
    Gets a value in the current occurrence of this scope.
    
    Parameters:
    key - The key to get.
    
    Returns:
    The scoped value for the given key.
  - 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

Class GuiceSimpleScope

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.inject.Scope

Constructor Detail

GuiceSimpleScope

Method Detail

getUnscopedProvider

enter

exit

isActive

seed

seed

getForTesting

scope