net.openhft.chronicle.core.io

Class VanillaReferenceCounted

java.lang.Object

net.openhft.chronicle.core.io.VanillaReferenceCounted

All Implemented Interfaces:

MonitorReferenceCounted, ReferenceCounted, ReferenceCountedTracer, ReferenceOwner

public final class VanillaReferenceCounted
extends Object
implements MonitorReferenceCounted

This class provides a basic implementation of the MonitorReferenceCounted interface. It is responsible for keeping track of reference counts and releasing resources once they are no longer needed.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Method Summary

Modifier and Type	Method and Description
void	addReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Adds a ReferenceChangeListener that will be notified when references are added or removed.
StackTrace	createdHere() Retrieves the stack trace of the point where the object was created.
int	refCount() Returns the current reference count of the resource.
void	release(ReferenceOwner id) Releases the resource reserved by the provided reference owner.
void	releaseLast(ReferenceOwner id) Releases the last reference of the resource.
void	removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Removes a ReferenceChangeListener from being notified when references are added or removed.
void	reserve(ReferenceOwner id) Reserves the resource for the provided reference owner.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to) Transfers the reservation of the resource from one reference owner to another.
void	throwExceptionIfNotReleased() Throws an exception if the object has not been released.
String	toString()
boolean	tryReserve(ReferenceOwner id) Attempts to reserve the resource for the provided reference owner.
boolean	unmonitored()
void	unmonitored(boolean unmonitored) Sets the monitored state of the object.
void	warnAndReleaseIfNotReleased() Releases any remaining references and logs a warning if there were any references to release.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCountedTracer

onReleased, throwExceptionIfReleased

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted

releaseLast

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Method Detail

createdHere

public StackTrace createdHere()

Description copied from interface: ReferenceCountedTracer

Retrieves the stack trace of the point where the object was created. This can be useful for debugging and tracking down the origin of the object.

Specified by:

createdHere in interface ReferenceCountedTracer

Returns:

The stack trace where the object was created.

reserve

public void reserve(ReferenceOwner id)
             throws ClosedIllegalStateException

Reserves the resource for the provided reference owner.

Specified by:

reserve in interface ReferenceCounted

Parameters:

id - The reference owner.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

reserveTransfer

public void reserveTransfer(ReferenceOwner from,
                            ReferenceOwner to)
                     throws ClosedIllegalStateException

Transfers the reservation of the resource from one reference owner to another.

Specified by:

reserveTransfer in interface ReferenceCounted

Parameters:

from - The current reference owner.

to - The new reference owner.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

tryReserve

public boolean tryReserve(ReferenceOwner id)

Attempts to reserve the resource for the provided reference owner.

Specified by:

tryReserve in interface ReferenceCounted

Parameters:

id - The reference owner.

Returns:

true if the reservation was successful, false if the object has already been released.

release

public void release(ReferenceOwner id)
             throws ClosedIllegalStateException

Releases the resource reserved by the provided reference owner.

Specified by:

release in interface ReferenceCounted

Parameters:

id - The reference owner.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

releaseLast

public void releaseLast(ReferenceOwner id)
                 throws IllegalStateException

Releases the last reference of the resource.

Specified by:

releaseLast in interface ReferenceCounted

Parameters:

id - The reference owner.

Throws:

IllegalStateException - If the object has more references.

refCount

public int refCount()

Description copied from interface: ReferenceCounted

Returns the current reference count of the resource. The reference count indicates the number of owners currently holding reservations to the resource.

Specified by:

refCount in interface ReferenceCounted

Returns:

The current reference count of the resource.

toString

public String toString()

Overrides:

toString in class Object

throwExceptionIfNotReleased

public void throwExceptionIfNotReleased()
                                 throws IllegalStateException

Description copied from interface: ReferenceCountedTracer

Throws an exception if the object has not been released.

Specified by:

throwExceptionIfNotReleased in interface ReferenceCountedTracer

Throws:

IllegalStateException - If the object has not been released (i.e., its reference count is greater than 0).

warnAndReleaseIfNotReleased

public void warnAndReleaseIfNotReleased()
                                 throws IllegalStateException

Description copied from interface: ReferenceCountedTracer

Releases any remaining references and logs a warning if there were any references to release.

This method is intended to be called by a finalizer or in a test to confirm that references are being released correctly.

Note: This method will not trigger any ReferenceChangeListeners as it is mainly used for sanity checks.

Specified by:

warnAndReleaseIfNotReleased in interface ReferenceCountedTracer

Throws:

ClosedIllegalStateException - If the object has not been released.

IllegalStateException

unmonitored

public void unmonitored(boolean unmonitored)

Description copied from interface: MonitorReferenceCounted

Sets the monitored state of the object.

Specified by:

unmonitored in interface MonitorReferenceCounted

Parameters:

unmonitored - true to set the object as unmonitored, false to set it as monitored.

unmonitored

public boolean unmonitored()

Specified by:

unmonitored in interface MonitorReferenceCounted

Returns:

true if the object is unmonitored, false if it is monitored.

addReferenceChangeListener

public void addReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Adds a ReferenceChangeListener that will be notified when references are added or removed.

Specified by:

addReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The ReferenceChangeListener to be added.

removeReferenceChangeListener

public void removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Removes a ReferenceChangeListener from being notified when references are added or removed.

Specified by:

removeReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The ReferenceChangeListener to be removed.