Scope

java.lang.Object
- dagger.model.Scope

@DoNotMock(value="Use Scope.scope(AnnotationMirror) to create an instance")
public abstract class Scope
extends Object

A representation of a Scope.

Constructor Summary

Constructors
Constructor and Description

Scope()

Constructors
Constructor and Description
`Scope()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReleaseReferences()` Returns `true` for scopes that are annotated with `CanReleaseReferences` or some other annotation that is itself annotated with `CanReleaseReferences`.
`boolean`	`isProductionScope()` Returns `true` if this scope is the `@ProductionScope` scope.
`boolean`	`isReusable()` Returns `true` if this scope is the `@Reusable` scope.
`static boolean`	`isScope(AnnotationMirror scopeAnnotation)` Returns `true` if `scopeAnnotation()` is a `Scope` annotation.
`static boolean`	`isScope(TypeElement scopeAnnotationType)` Returns `true` if `scopeAnnotationType` is a `Scope` annotation.
`boolean`	`isSingleton()` Returns `true` if this scope is the `@Singleton` scope.
`ImmutableSet<AnnotationMirror>`	`releasableReferencesMetadata()` Returns the set of annotations on the scope that are themselves annotated with `CanReleaseReferences`.
`Optional<AnnotationMirror>`	`releasableReferencesMetadata(TypeMirror metadataType)` Returns the releasable references metadata annotation of the given type, if there is one for this scope.
`static Scope`	`scope(AnnotationMirror scopeAnnotation)` Creates a `Scope` object from the `Scope`-annotated annotation type.
`AnnotationMirror`	`scopeAnnotation()` The `AnnotationMirror` that represents the scope annotation.
`TypeElement`	`scopeAnnotationElement()` The scope annotation element.
`String`	`toString()` Returns a debug representation of the scope.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Scope
```
public Scope()
```
- Method Detail
  - scopeAnnotation
```
public final AnnotationMirror scopeAnnotation()
```
    The AnnotationMirror that represents the scope annotation.
  - scopeAnnotationElement
```
public final TypeElement scopeAnnotationElement()
```
    The scope annotation element.
  - scope
```
public static Scope scope(AnnotationMirror scopeAnnotation)
```
    Creates a Scope object from the Scope-annotated annotation type.
  - isScope
```
public static boolean isScope(AnnotationMirror scopeAnnotation)
```
    Returns true if scopeAnnotation() is a Scope annotation.
  - isScope
```
public static boolean isScope(TypeElement scopeAnnotationType)
```
    Returns true if scopeAnnotationType is a Scope annotation.
  - isSingleton
```
public final boolean isSingleton()
```
    Returns true if this scope is the @Singleton scope.
  - isReusable
```
public final boolean isReusable()
```
    Returns true if this scope is the @Reusable scope.
  - isProductionScope
```
public final boolean isProductionScope()
```
    Returns true if this scope is the @ProductionScope scope.
  - canReleaseReferences
```
public final boolean canReleaseReferences()
```
    Returns true for scopes that are annotated with CanReleaseReferences or some other annotation that is itself annotated with CanReleaseReferences.
  - releasableReferencesMetadata
```
public final ImmutableSet<AnnotationMirror> releasableReferencesMetadata()
```
    Returns the set of annotations on the scope that are themselves annotated with CanReleaseReferences. These annotations are used as metadata for TypedReleasableReferenceManager.
  - releasableReferencesMetadata
```
public final Optional<AnnotationMirror> releasableReferencesMetadata(TypeMirror metadataType)
```
    Returns the releasable references metadata annotation of the given type, if there is one for this scope.
  - toString
```
public String toString()
```
    Returns a debug representation of the scope.
    
    Overrides:
    
    toString in class Object

Class Scope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scope

Method Detail

scopeAnnotation

scopeAnnotationElement

scope

isScope

isScope

isSingleton

isReusable

isProductionScope

canReleaseReferences

releasableReferencesMetadata

releasableReferencesMetadata

toString