Module io.smallrye.common.ref
Package io.smallrye.common.ref

Interface Reference<T,A>

Type Parameters:
T - the reference value type
A - the attachment type
All Known Implementing Classes:
CleanerReference, PhantomReference, SoftReference, StrongReference, WeakReference
public interface Reference<T,A>
An enhanced reference type with a type-safe attachment.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Reference.Type
    A reference type.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clear the reference.
    T
    get()
    Get the value, or null if the reference has been cleared.
    A
    getAttachment()
    Get the attachment, if any.
    Reference.Type
    getType()
    Get the type of the reference.

  • Method Details

    • get

      T get()
      Get the value, or null if the reference has been cleared.
      Returns:
      the value

    • getAttachment

      A getAttachment()
      Get the attachment, if any.
      Returns:
      the attachment

    • clear

      void clear()
      Clear the reference.

    • getType

      Reference.Type getType()
      Get the type of the reference.
      Returns:
      the type