Google Guice - Core Library 7.0.0 · com.google.inject.internal.Scoping

Modifier and Type	Field and Description
public static final Scoping	EAGER_SINGLETON
private static final Scoping	EXPLICITLY_UNSCOPED No scoping annotation has been applied explicitly.
public static final Scoping	SINGLETON_ANNOTATION
public static final Scoping	SINGLETON_INSTANCE
public static final Scoping	UNSCOPED No scoping annotation has been applied.

Access	Constructor and Description
private	Scoping()

Method Summary

Modifier and Type	Method and Description
public abstract <V> V	acceptVisitor(BindingScopingVisitor<V> visitor)
public abstract void	applyTo(ScopedBindingBuilder scopedBindingBuilder)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static Scoping	forAnnotation(final Class<? extends Annotation> scopingAnnotation)
public static Scoping	forInstance(final Scope scope)
public Class<? extends Annotation>	getScopeAnnotation() Returns the scope annotation, or `null` if that isn't known for this instance.
public Scope	getScopeInstance() Returns the scope instance, or `null` if that isn't known for this instance.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEagerSingleton(Stage stage) Returns true if this scope is a singleton that should be loaded eagerly in `stage`.
public boolean	isExplicitlyScoped() Returns true if this scope was explicitly applied.
public boolean	isNoScope() Returns true if this is the default scope.
pack-priv static Scoping	makeInjectable(Scoping scoping, InjectorImpl injector, Errors errors) Replaces annotation scopes with instance scopes using the Injector's annotation-to-instance map.
pack-priv static <T> InternalFactory<? extends T>	scope(Key<T> key, InjectorImpl injector, InternalFactory<? extends T> creator, Object source, Scoping scoping) Scopes an internal factory.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

EAGER_SINGLETON	back to summary
public static final Scoping EAGER_SINGLETON

EXPLICITLY_UNSCOPED	back to summary
private static final Scoping EXPLICITLY_UNSCOPED No scoping annotation has been applied explicitly. Note that this is is the same as `in(Scopes.NO_SCOPE)`.

SINGLETON_ANNOTATION	back to summary
public static final Scoping SINGLETON_ANNOTATION

SINGLETON_INSTANCE	back to summary
public static final Scoping SINGLETON_INSTANCE

UNSCOPED	back to summary
public static final Scoping UNSCOPED No scoping annotation has been applied. Note that this is different from `in(Scopes.NO_SCOPE)`, where the 'NO_SCOPE' has been explicitly applied.

Scoping	back to summary
private Scoping()

Method Detail

acceptVisitor	back to summary
public abstract <V> V acceptVisitor(BindingScopingVisitor<V> visitor)

applyTo	back to summary
public abstract void applyTo(ScopedBindingBuilder scopedBindingBuilder)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

forAnnotation	back to summary
public static Scoping forAnnotation(final Class<? extends Annotation> scopingAnnotation)

forInstance	back to summary
public static Scoping forInstance(final Scope scope)

getScopeAnnotation	back to summary
public Class<? extends Annotation> getScopeAnnotation() Returns the scope annotation, or `null` if that isn't known for this instance.

getScopeInstance	back to summary
public Scope getScopeInstance() Returns the scope instance, or `null` if that isn't known for this instance.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isEagerSingleton	back to summary
public boolean isEagerSingleton(Stage stage) Returns true if this scope is a singleton that should be loaded eagerly in `stage`.

isExplicitlyScoped	back to summary
public boolean isExplicitlyScoped() Returns true if this scope was explicitly applied. If no scope was explicitly applied then the scoping annotation will be used.

isNoScope	back to summary
public boolean isNoScope() Returns true if this is the default scope. In this case a new instance will be provided for each injection.

makeInjectable	back to summary
pack-priv static Scoping makeInjectable(Scoping scoping, InjectorImpl injector, Errors errors) Replaces annotation scopes with instance scopes using the Injector's annotation-to-instance map. If the scope annotation has no corresponding instance, an error will be added and unscoped will be returned.

scope	back to summary
pack-priv static <T> InternalFactory<? extends T> scope(Key<T> key, InjectorImpl injector, InternalFactory<? extends T> creator, Object source, Scoping scoping) Scopes an internal factory.

public abstract Class Scoping

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail