Packages

c

scala.ref

PhantomReference

class PhantomReference[+T <: AnyRef] extends ReferenceWrapper[T]

Source
PhantomReference.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PhantomReference
  2. ReferenceWrapper
  3. Proxy
  4. Reference
  5. Function0
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PhantomReference(value: T, queue: ReferenceQueue[T])

Value Members

  1. def apply(): T

    return the underlying value

    return the underlying value

    returns

    the result of function application.

    Definition Classes
    ReferenceWrapperReferenceFunction0
  2. def clear(): Unit
    Definition Classes
    ReferenceWrapperReference
  3. def enqueue(): Boolean
    Definition Classes
    ReferenceWrapperReference
  4. def equals(that: Any): Boolean

    Compares the receiver object (this) with the argument object (that) for equivalence.

    Compares the receiver object (this) with the argument object (that) for equivalence.

    Any implementation of this method should be an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

    that

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    ProxyAny
  5. def get: Option[T]

    return Some underlying if it hasn't been collected, otherwise None

    return Some underlying if it hasn't been collected, otherwise None

    Definition Classes
    ReferenceWrapperReference
  6. def hashCode(): Int

    Calculate a hash code value for the object.

    Calculate a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for this object.

    Definition Classes
    ProxyAny
  7. def isEnqueued(): Boolean
    Definition Classes
    ReferenceWrapperReference
  8. def self: java.lang.ref.Reference[_ <: T]
    Definition Classes
    ReferenceWrapperProxy
  9. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    Definition Classes
    ProxyAny
  10. val underlying: java.lang.ref.PhantomReference[_ <: T]
    Definition Classes
    PhantomReferenceReferenceWrapper