Top Description Inners Fields Constructors Methods
com.google.inject.internal

pack-priv final Class WeakKeySet

extends Object
Class Inheritance
Imports
com.google.common.base.Objects, .Preconditions, com.google.common.cache.Cache, .CacheBuilder, .RemovalCause, .RemovalNotification, com.google.common.collect.LinkedHashMultiset, .Maps, .Multiset, .Sets, com.google.inject.Key, com.google.inject.internal.util.SourceProvider, java.util.Map, .Set

Minimal set that doesn't hold strong references to the contained keys.
Author
[email protected] (Daniel Weis)

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private Map<Key<?>, Multiset<Object>>
private final Cache<InjectorBindingData, Set<WeakKeySet.KeyAndSource>>
evictionCache

Tracks child injector lifetimes and evicts banned keys/sources after the child injector is garbage collected.

private final Object
lock

This is already locked externally on add and getSources but we need it to handle clean up in the evictionCache's RemovalListener.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
add(Key<?> key, InjectorBindingData state, Object source)

private void
public boolean
contains(Key<?> key)

public Set<Object>
getSources(Key<?> key)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

backingMapback to summary
private Map<Key<?>, Multiset<Object>> backingMap
evictionCacheback to summary
private final Cache<InjectorBindingData, Set<WeakKeySet.KeyAndSource>> evictionCache

Tracks child injector lifetimes and evicts banned keys/sources after the child injector is garbage collected.

lockback to summary
private final Object lock

This is already locked externally on add and getSources but we need it to handle clean up in the evictionCache's RemovalListener.

Constructor Detail

WeakKeySetback to summary
pack-priv WeakKeySet(Object lock)

Method Detail

addback to summary
public void add(Key<?> key, InjectorBindingData state, Object source)
cleanupOnRemovalback to summary
private void cleanupOnRemoval(RemovalNotification<InjectorBindingData, Set<WeakKeySet.KeyAndSource>> notification)
containsback to summary
public boolean contains(Key<?> key)
getSourcesback to summary
public Set<Object> getSources(Key<?> key)
com.google.inject.internal back to summary

private final Class WeakKeySet.KeyAndSource

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final Key<?>
pack-priv final Object

Constructor Summary

AccessConstructor and Description
pack-priv
KeyAndSource(Key<?> key, Object source)

Method Summary

Modifier and TypeMethod and Description
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 int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

keyback to summary
pack-priv final Key<?> key
sourceback to summary
pack-priv final Object source

Constructor Detail

KeyAndSourceback to summary
pack-priv KeyAndSource(Key<?> key, Object source)

Method Detail

equalsback 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
hashCodeback 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