Top Description Fields Constructors Methods
io.smallrye.common.ref

public Class CleanerReference<T, A>

extends PhantomReference<T, A>
Class Inheritance
Type Parameters
<T>
the referent type
<A>
the attachment type
Imports
java.util.Collections, .Set, java.util.concurrent.ConcurrentHashMap

A special version of PhantomReference that is strongly retained until it is reaped by the collection thread.

Field Summary

Modifier and TypeField and Description
private static final Set<CleanerReference<?, ?>>

Constructor Summary

AccessConstructor and Description
public
CleanerReference(final T
the referent
referent
,
final A
the attachment
attachment
,
final Reaper<T, A>
the reaper to use
reaper
)

Construct a new instance with a reaper.

Method Summary

Modifier and TypeMethod and Description
pack-priv void
public final boolean
equals(final 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 final int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from io.smallrye.common.ref.PhantomReference:
getAttachmentgetReapergetTypetoString

Field Detail

setback to summary
private static final Set<CleanerReference<?, ?>> set

Constructor Detail

CleanerReferenceback to summary
public CleanerReference(final T referent, final A attachment, final Reaper<T, A> reaper)

Construct a new instance with a reaper.

Parameters
referent:T

the referent

attachment:A

the attachment

reaper:Reaper<T, A>

the reaper to use

Method Detail

cleanback to summary
pack-priv void clean()
equalsback to summary
public final boolean equals(final 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.

hashCodeback to summary
public final 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