net.openhft.chronicle.core.io

Class AbstractCloseable

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedCloseable, QueryCloseable, ReferenceOwner

Direct Known Subclasses:

UnsafeCloseable

public abstract class AbstractCloseable
extends Object
implements ReferenceOwner, ManagedCloseable

Field Summary

Fields

Modifier and Type	Field and Description
protected StackTrace	closedHere
protected static boolean	DISABLE_DISCARD_WARNING
protected static boolean	DISABLE_THREAD_SAFETY
protected static boolean	STRICT_DISCARD_WARNING
protected static long	WARN_NS

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

INIT, TMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloseable()

Method Summary

Modifier and Type	Method and Description
protected void	assertCloseable() Asserts that this resource can be closed, throwing an IllegalStateException if it cannot.
static void	assertCloseablesClosed()
void	clearUsedByThread()
void	close() Closes this resource, potentially preventing parts of it from being used again and potentially relinquishing resources held.
StackTrace	createdHere()
static void	disableCloseableTracing()
boolean	disableThreadSafetyCheck()
AbstractCloseable	disableThreadSafetyCheck(boolean disableThreadSafetyCheck)
static void	enableCloseableTracing()
static void	gcAndWaitForCloseablesToClose()
boolean	isClosed() Is this object closed
boolean	isClosing() Is this object closed, or in the process of closing
protected boolean	isInUserThread()
protected abstract void	performClose() Call close() to ensure this is called exactly once.
int	referenceId()
void	resetUsedByThread()
protected boolean	shouldPerformCloseInBackground()
protected boolean	shouldWaitForClosed()
protected void	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)
static boolean	waitForCloseablesToClose(long millis)
protected void	waitForClosed()
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.ReferenceOwner

referenceName, temporary

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

closeQuietly, closeQuietly

Field Detail

DISABLE_THREAD_SAFETY

protected static final boolean DISABLE_THREAD_SAFETY

DISABLE_DISCARD_WARNING

protected static final boolean DISABLE_DISCARD_WARNING

STRICT_DISCARD_WARNING

protected static final boolean STRICT_DISCARD_WARNING

WARN_NS

protected static final long WARN_NS

closedHere

protected transient volatile StackTrace closedHere

Constructor Detail

AbstractCloseable

protected AbstractCloseable()

Method Detail

enableCloseableTracing

public static void enableCloseableTracing()

disableCloseableTracing

public static void disableCloseableTracing()

gcAndWaitForCloseablesToClose

public static void gcAndWaitForCloseablesToClose()

waitForCloseablesToClose

public static boolean waitForCloseablesToClose(long millis)

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 ManagedCloseable

close

public final void close()

Description copied from interface: Closeable

Closes this resource, potentially preventing parts of it from being used again and potentially relinquishing resources held.

This method is idem-potent.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

assertCloseable

protected void assertCloseable()

Asserts that this resource can be closed, throwing an IllegalStateException if it cannot.

This can be useful for resources that have outstanding guarantees such as acquired update locks or open contexts.

Electing to throw an Exception might cause memory-leaks as there is no guarantee that the close methods will ever be invoked again in the general case.

Throws:

IllegalStateException - if the resource cannot be closed.

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 ManagedCloseable

Throws:

ClosedIllegalStateException - if closed

IllegalStateException - if the thread safety check fails

throwExceptionIfClosedInSetter

public void throwExceptionIfClosedInSetter()
                                    throws IllegalStateException

Throws:

IllegalStateException

warnAndCloseIfNotClosed

public void warnAndCloseIfNotClosed()

Called from finalise() implementations.

Specified by:

warnAndCloseIfNotClosed in interface ManagedCloseable

performClose

protected abstract void performClose()
                              throws IllegalStateException

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

Throws:

IllegalStateException

isClosing

public boolean isClosing()

Description copied from interface: QueryCloseable

Is this object closed, or in the process of closing

This should always be true if QueryCloseable.isClosed() is true

Specified by:

isClosing in interface QueryCloseable

Returns:

true if close() has been called (but not necessarily completed)

isClosed

public boolean isClosed()

Description copied from interface: QueryCloseable

Is this object closed

Specified by:

isClosed in interface QueryCloseable

Returns:

true if close() has completed

shouldPerformCloseInBackground

protected boolean shouldPerformCloseInBackground()

Returns:

whether this component should be closed in the background or not

shouldWaitForClosed

protected boolean shouldWaitForClosed()

Returns:

whether this component should be wait for closed to complete

threadSafetyCheck

protected void threadSafetyCheck(boolean isUsed)
                          throws IllegalStateException

Throws:

IllegalStateException

resetUsedByThread

public void resetUsedByThread()

clearUsedByThread

public void clearUsedByThread()

toString

public String toString()

Overrides:

toString in class Object

disableThreadSafetyCheck

public boolean disableThreadSafetyCheck()

disableThreadSafetyCheck

public AbstractCloseable disableThreadSafetyCheck(boolean disableThreadSafetyCheck)