net.openhft.chronicle.core.io

Class AbstractCloseableReferenceCounted

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedCloseable, QueryCloseable, ReferenceCounted, ReferenceCountedTracer, ReferenceOwner, SingleThreadedChecked

public abstract class AbstractCloseableReferenceCounted
extends AbstractReferenceCounted
implements ManagedCloseable

An abstract class representing a reference-counted closeable resource. This class extends AbstractReferenceCounted and implements ManagedCloseable.

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounted, WARN_COUNT, WARN_NS

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

INIT, TMP

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

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloseableReferenceCounted() Constructs a new AbstractCloseableReferenceCounted instance.

Method Summary

Modifier and Type	Method and Description
protected void	backgroundPerformRelease() Closes the resource in the background.
void	close() Closes the resource.
boolean	isClosed() Checks if this object is closed.
void	release(ReferenceOwner id) Releases the resource for the given id.
void	releaseLast(ReferenceOwner id) Releases the resource for the given id and checks the resource is now released.
void	reserve(ReferenceOwner id) Reserves the resource for the given id.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to) Reserves the resource for the given id.
protected void	setClosed() Sets the resource as closed.
protected void	setClosing() Sets the resource as closing in case it is being released in the background.
void	throwExceptionIfClosed() Throws an exception if the resource is closed.
protected void	throwExceptionIfClosedInSetter() Throws an exception if the resource is closed while in a setter method.
boolean	tryReserve(ReferenceOwner id) Tries to reserve the resource for the given id.

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

addReferenceChangeListener, assertReferencesReleased, canReleaseInBackground, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, referenceCountedUnmonitored, referenceId, removeReferenceChangeListener, reservedBy, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, toString, unmonitor, warnAndReleaseIfNotReleased

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.ManagedCloseable

createdHere, warnAndCloseIfNotClosed

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

closeQuietly, closeQuietly

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

isClosing

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

onReleased

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

releaseLast

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

referenceName, temporary

Constructor Detail

AbstractCloseableReferenceCounted

protected AbstractCloseableReferenceCounted()

Constructs a new AbstractCloseableReferenceCounted instance. Adds the instance to the CloseableUtils set for tracking.

Method Detail

reserve

public void reserve(ReferenceOwner id)
             throws IllegalStateException

Reserves the resource for the given id.

Specified by:

reserve in interface ReferenceCounted

Overrides:

reserve in class AbstractReferenceCounted

Parameters:

id - unique id for this reserve

Throws:

IllegalStateException - if already released

reserveTransfer

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

Reserves the resource for the given id.

Specified by:

reserveTransfer in interface ReferenceCounted

Overrides:

reserveTransfer in class AbstractReferenceCounted

Parameters:

from - resource

to - resource

Throws:

IllegalStateException - if resource is already released

release

public void release(ReferenceOwner id)
             throws IllegalStateException

Releases the resource for the given id.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Parameters:

id - unique id for this release

Throws:

IllegalStateException - if resource is already released

releaseLast

public void releaseLast(ReferenceOwner id)
                 throws IllegalStateException

Releases the resource for the given id and checks the resource is now released.

Specified by:

releaseLast in interface ReferenceCounted

Overrides:

releaseLast in class AbstractReferenceCounted

Parameters:

id - unique id for this release

Throws:

IllegalStateException - if resource is already released

tryReserve

public boolean tryReserve(ReferenceOwner id)
                   throws IllegalStateException,
                          IllegalArgumentException

Tries to reserve the resource for the given id.

Specified by:

tryReserve in interface ReferenceCounted

Overrides:

tryReserve in class AbstractReferenceCounted

Parameters:

id - unique id for this reserve

Returns:

true if reserved

Throws:

IllegalStateException - if resource is already released

IllegalArgumentException

close

public void close()

Closes the resource.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

backgroundPerformRelease

protected void backgroundPerformRelease()

Closes the resource in the background.

Overrides:

backgroundPerformRelease in class AbstractReferenceCounted

setClosing

protected void setClosing()

Sets the resource as closing in case it is being released in the background.

setClosed

protected void setClosed()

Sets the resource as closed.

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws IllegalStateException

Throws an exception if the resource is closed.

Specified by:

throwExceptionIfClosed in interface ManagedCloseable

Throws:

IllegalStateException - if closed

throwExceptionIfClosedInSetter

protected void throwExceptionIfClosedInSetter()
                                       throws IllegalStateException

Throws an exception if the resource is closed while in a setter method.

Throws:

IllegalStateException - if closed

isClosed

public boolean isClosed()

Description copied from interface: QueryCloseable

Checks if this object is closed.

Specified by:

isClosed in interface QueryCloseable

Returns:

true if the resource is closed