org.netbeans.api.editor.document

Class EditorDocumentUtils

java.lang.Object

org.netbeans.api.editor.document.EditorDocumentUtils

public final class EditorDocumentUtils
extends Object

Utilities operation on top of an editor document.

Since:

1.58

Method Summary

Methods

Modifier and Type	Method and Description
static void	runExclusive(Document doc, Runnable r) Execute a non mutating runnable under an exclusive document lock over the document (no other read locks or write locks are taking place).

Methods inherited from class java.lang.Object

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

Method Detail

runExclusive

public static void runExclusive(Document doc,
                Runnable r)

Execute a non mutating runnable under an exclusive document lock over the document (no other read locks or write locks are taking place).
Nested calls to runExclusive(Document, Runnable) are allowed. The given runnable may also call Document.render(Runnable).
However any mutations by Document.insertString(int, String, javax.swing.text.AttributeSet) or Document.remove(int, int) are prohibited.
Calling atomic transactions (BaseDocument.runAtomic() or NbDocument.runAtomic()) from the given runnable is prohibited as well.
Calls to runExclusive(Document, Runnable) within an atomic section are allowed (but no document mutations may be done during runExclusive() call).
Calls to Document.render(java.lang.Runnable) within runExclusive(Document, Runnable) are allowed.
Calls to runExclusive(Document, Runnable) within Document.render(java.lang.Runnable) are prohibited and may lead to starvation.

Parameters:

doc - document being exclusively locked. For non-editor document implementations (currently org.netbeans.editor.BaseDocument) the implementation synchronizes over the document and does not check for mutations within runExclusive().

r - runnable to be performed. It is not allowed to mutate the document by any insertions or removals.

Throws:

IllegalStateException - in case the given runnable wants to mutate the document.

Since:

1.58