Class scala.ref.PhantomReference
class PhantomReference[+T <: AnyRef] extends ReferenceWrapper[T]
- Source
- PhantomReference.scala
- Linear Supertypes
- ReferenceWrapper[T], Proxy, Reference[T], () => T, AnyRef, Any
Instance Constructors
new PhantomReference(value: T, queue: ReferenceQueue[T])
Value Members
final def !=(arg0: Any): Boolean
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
final def ##(): Int
Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.
- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toany2stringadd[PhantomReference[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
def ->[B](y: B): (PhantomReference[T], B)
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toArrowAssoc[PhantomReference[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
final def ==(arg0: Any): Boolean
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- AnyRef → Any
def apply(): T
return the underlying value
- returns
the result of function application.
- Definition Classes
- ReferenceWrapper → Reference → Function0
final def asInstanceOf[T0]: T0
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
def clear(): Unit
- Definition Classes
- ReferenceWrapper → Reference
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
- returns
a copy of the receiver object.
def enqueue(): Boolean
- Definition Classes
- ReferenceWrapper → Reference
def ensuring(cond: (PhantomReference[T]) => Boolean, msg: => Any): PhantomReference[T]
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toEnsuring[PhantomReference[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (PhantomReference[T]) => Boolean): PhantomReference[T]
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toEnsuring[PhantomReference[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: => Any): PhantomReference[T]
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toEnsuring[PhantomReference[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): PhantomReference[T]
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toEnsuring[PhantomReference[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
-
It is consistent: for any non-null instances
x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
null.eq(null) returns true. When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
- returns
trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
- AnyRef
def equals(that: Any): Boolean
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
trueif the receiver object is equivalent to the argument;falseotherwise.
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.
def formatted(fmtstr: String): String
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from PhantomReference[T] toStringFormat[PhantomReference[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
def get: Option[T]
return Some underlying if it hasn't been collected, otherwise None
- Definition Classes
- ReferenceWrapper → Reference
final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def hashCode(): Int
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.
def isEnqueued: Boolean
- Definition Classes
- ReferenceWrapper → Reference
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
- returns
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that).
- returns
trueif the argument is not a reference to the receiver object;falseotherwise.
- Definition Classes
- AnyRef
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
def self: java.lang.ref.Reference[_ <: T]
- Definition Classes
- ReferenceWrapper → Proxy
final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
def toString(): String
Returns a string representation of the object.
The default representation is platform dependent.
- returns
a string representation of the object.
val underlying: java.lang.ref.PhantomReference[_ <: T]
- Definition Classes
- PhantomReference → ReferenceWrapper
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/ref/PhantomReference.html