Package org.opensearch.common.util.concurrent

Class AbstractRefCounted

java.lang.Object
org.opensearch.common.util.concurrent.AbstractRefCounted
All Implemented Interfaces:
RefCounted
public abstract class AbstractRefCounted extends Object implements RefCounted
A basic RefCounted implementation that is initialized with a ref count of 1 and calls closeInternal() once it reaches a 0 ref count
Opensearch.api:

  • Constructor Details

    • AbstractRefCounted

      public AbstractRefCounted(String name)

  • Method Details

    • incRef

      public final void incRef()
      Description copied from interface: RefCounted
      Increments the refCount of this instance.
      Specified by:
      incRef in interface RefCounted
      See Also:

    • tryIncRef

      public final boolean tryIncRef()
      Description copied from interface: RefCounted
      Tries to increment the refCount of this instance. This method will return true iff the refCount was
      Specified by:
      tryIncRef in interface RefCounted
      See Also:

    • decRef

      public final boolean decRef()
      Description copied from interface: RefCounted
      Decreases the refCount of this instance. If the refCount drops to 0, then this instance is considered as closed and should not be used anymore.
      Specified by:
      decRef in interface RefCounted
      Returns:
      returns true if the ref count dropped to 0 as a result of calling this method
      See Also:

    • alreadyClosed

      protected void alreadyClosed()

    • refCount

      public int refCount()
      Returns the current reference count.

    • getName

      public String getName()
      gets the name of this instance

    • closeInternal

      protected abstract void closeInternal()