net.openhft.chronicle.core.io

Class AbstractCloseable

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

All Implemented Interfaces:

Closeable, AutoCloseable, CloseableTracer, QueryCloseable, ReferenceOwner

Direct Known Subclasses:

UnsafeCloseable

public abstract class AbstractCloseable
extends Object
implements CloseableTracer, ReferenceOwner

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	CHECK_THREAD_SAFETY
protected static long	WARN_NS

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

INIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloseable()

Method Summary

Modifier and Type	Method and Description
static void	assertCloseablesClosed()
void	clearUsedByThread()
void	close() Close a resource so it cannot be used again.
StackTrace	createdHere()
static void	disableCloseableTracing()
static void	enableCloseableTracing()
boolean	isClosed()
boolean	isClosing()
protected boolean	isInUserThread()
protected abstract void	performClose() Call close() to ensure this is called exactly once.
protected boolean	performCloseInBackground() Deprecated.
int	referenceId()
void	resetUsedByThread()
protected boolean	shouldPerformCloseInBackground()
protected boolean	shouldWaitForClosed()
protected boolean	threadSafetyCheck(boolean isUsed)
void	throwExceptionIfClosed() Called when a resources needs to be open to use it.
void	throwExceptionIfClosedInSetter()
String	toString()
static void	unmonitor(Closeable closeable)
protected void	waitForClosed()
protected void	warnAndCloseIfNotClosed() Called from finalise() implementations.

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

closeQuietly, closeQuietly, notifyClosing

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

referenceName, temporary

Field Detail

CHECK_THREAD_SAFETY

protected static final boolean CHECK_THREAD_SAFETY

WARN_NS

protected static final long WARN_NS

Constructor Detail

AbstractCloseable

protected AbstractCloseable()

Method Detail

enableCloseableTracing

public static void enableCloseableTracing()

disableCloseableTracing

public static void disableCloseableTracing()

assertCloseablesClosed

public static void assertCloseablesClosed()

unmonitor

public static void unmonitor(Closeable closeable)

referenceId

public int referenceId()

Specified by:

referenceId in interface ReferenceOwner

createdHere

public StackTrace createdHere()

Specified by:

createdHere in interface CloseableTracer

close

public final void close()

Close a resource so it cannot be used again.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isInUserThread

protected boolean isInUserThread()

waitForClosed

protected void waitForClosed()

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws IllegalStateException

Called when a resources needs to be open to use it.

Specified by:

throwExceptionIfClosed in interface QueryCloseable

Throws:

IllegalStateException - if closed

throwExceptionIfClosedInSetter

public void throwExceptionIfClosedInSetter()
                                    throws IllegalStateException

Throws:

IllegalStateException

warnAndCloseIfNotClosed

protected void warnAndCloseIfNotClosed()

Called from finalise() implementations.

performClose

protected abstract void performClose()

Call close() to ensure this is called exactly once.

isClosing

public boolean isClosing()

Specified by:

isClosing in interface QueryCloseable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface QueryCloseable

shouldPerformCloseInBackground

protected boolean shouldPerformCloseInBackground()

Returns:

whether this component should be closed in the background or not

performCloseInBackground

@Deprecated
protected boolean performCloseInBackground()

Deprecated.

shouldWaitForClosed

protected boolean shouldWaitForClosed()

Returns:

whether this component should be wait for closed to complete

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)

resetUsedByThread

public void resetUsedByThread()

clearUsedByThread

public void clearUsedByThread()

toString

public String toString()

Overrides:

toString in class Object