maspack.util

Class ReferenceCountedBase

java.lang.Object

maspack.util.ReferenceCountedBase

All Implemented Interfaces:

ReferenceCounted

Direct Known Subclasses:

DicomPlaneTextureContent, DicomTextureContent, DTITextureContent, GLResourceBase, NiftiTextureContent, TextureContentImage, TextureContentText

public abstract class ReferenceCountedBase
extends java.lang.Object
implements ReferenceCounted

Base implementation of ReferenceCounted

Field Summary

Fields

Modifier and Type	Field and Description
static int	traceHistorySize Number of most-recent acquire/release events retained per object when traceReferences is enabled.
static boolean	traceReferences When set true, every acquire()/release() records the calling stack, and the full acquire/release history is dumped if the reference count ever underflows.

Constructor Summary

Constructors

Constructor and Description
ReferenceCountedBase()

Method Summary

Modifier and Type	Method and Description
ReferenceCountedBase	acquire() Signal the resource that something is holding a reference to it.
long	acquireAndCount() Signal the resource that something is holding a reference to it.
long	getReferenceCount() Number of active references
void	release() Signal the resource that a previous hold is complete
long	releaseAndCount() Signal the resource that a previous hold is complete.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

traceReferences

public static boolean traceReferences

When set true, every acquire()/release() records the calling stack, and the full acquire/release history is dumped if the reference count ever underflows. This makes it possible to pinpoint the two colliding call sites (the extra release, and the acquire it should have balanced against). Off by default since it adds per-call overhead and synchronization; enable it while hunting a "didn't properly keep track of releases" message. May be set via the system property maspack.util.traceReferences=true.

traceHistorySize

public static int traceHistorySize

Number of most-recent acquire/release events retained per object when traceReferences is enabled.

Constructor Detail

ReferenceCountedBase

public ReferenceCountedBase()

Method Detail

acquire

public ReferenceCountedBase acquire()

Description copied from interface: ReferenceCounted

Signal the resource that something is holding a reference to it.

Specified by:

acquire in interface ReferenceCounted

Returns:

a reference to the acquired object for convenience.

acquireAndCount

public long acquireAndCount()

Description copied from interface: ReferenceCounted

Signal the resource that something is holding a reference to it.

Specified by:

acquireAndCount in interface ReferenceCounted

Returns:

the current reference count

releaseAndCount

public long releaseAndCount()

Description copied from interface: ReferenceCounted

Signal the resource that a previous hold is complete.

Specified by:

releaseAndCount in interface ReferenceCounted

Returns:

the current reference count

release

public void release()

Description copied from interface: ReferenceCounted

Signal the resource that a previous hold is complete

Specified by:

release in interface ReferenceCounted

getReferenceCount

public long getReferenceCount()

Description copied from interface: ReferenceCounted

Number of active references

Specified by:

getReferenceCount in interface ReferenceCounted

Returns:

current reference count