Package com.intellij.openapi.util

Class Disposer

java.lang.Object

com.intellij.openapi.util.Disposer

public final class Disposer
extends java.lang.Object

Manages a parent-child relation of chained objects requiring cleanup.

A root node can be created via newDisposable() to which children are attached via subsequent calls to register(Disposable, Disposable). Invoking dispose(Disposable) will process all its registered children's Disposable.dispose() method.

See Also:

Disposable

Method Summary

Modifier and Type	Method and Description
static void	assertIsEmpty()
static void	assertIsEmpty(boolean throwError)
static void	clearDisposalTraces()
static void	dispose(Disposable disposable)
static void	dispose(Disposable disposable, boolean processUnregistered)
static void	disposeChildren(Disposable disposable)
static <T extends Disposable> T	findRegisteredObject(Disposable parentDisposable, T object)
static Disposable	get(java.lang.String key)
static java.lang.Throwable	getDisposalTrace(Disposable disposable)
static com.intellij.openapi.util.ObjectTree	getTree()
static boolean	isDebugDisposerOn()
static boolean	isDebugMode()
static boolean	isDisposed(Disposable disposable)
static boolean	isDisposing(Disposable disposable)
static Disposable	newDisposable()
static Disposable	newDisposable(java.lang.String debugName)
static void	register(Disposable parent, Disposable child) Registers child so it is disposed right before its parent.
static void	register(Disposable parent, Disposable child, java.lang.String key)
static boolean	setDebugMode(boolean debugMode)

Methods inherited from class java.lang.Object

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

Method Detail

isDebugDisposerOn

public static boolean isDebugDisposerOn()

newDisposable

public static Disposable newDisposable()

newDisposable

public static Disposable newDisposable(java.lang.String debugName)

register

public static void register(Disposable parent,
                            Disposable child)

Registers child so it is disposed right before its parent. See class JavaDoc for more details.

Throws:

IncorrectOperationException - If child has been registered with parent before; if parent is being disposed (isDisposing(Disposable)) or already disposed (isDisposed(Disposable).

register

public static void register(Disposable parent,
                            Disposable child,
                            java.lang.String key)

isDisposed

public static boolean isDisposed(Disposable disposable)

isDisposing

public static boolean isDisposing(Disposable disposable)

get

public static Disposable get(java.lang.String key)

dispose

public static void dispose(Disposable disposable)

disposeChildren

public static void disposeChildren(Disposable disposable)

dispose

public static void dispose(Disposable disposable,
                           boolean processUnregistered)

getTree

public static com.intellij.openapi.util.ObjectTree getTree()

assertIsEmpty

public static void assertIsEmpty()

assertIsEmpty

public static void assertIsEmpty(boolean throwError)

setDebugMode

public static boolean setDebugMode(boolean debugMode)

Returns:

old value

isDebugMode

public static boolean isDebugMode()

findRegisteredObject

public static <T extends Disposable> T findRegisteredObject(Disposable parentDisposable,
                                                            T object)

Returns:

object registered on parentDisposable which is equal to object, or null if not found

getDisposalTrace

public static java.lang.Throwable getDisposalTrace(Disposable disposable)

clearDisposalTraces

public static void clearDisposalTraces()