DocumentImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.openapi.editor.impl.DocumentImpl

All Implemented Interfaces:: Document, DocumentEx, UserDataHolder, UserDataHolderEx

public class DocumentImpl
extends UserDataHolderBase
implements DocumentEx

Field Summary
- Fields inherited from interface com.intellij.openapi.editor.Document
  EMPTY_ARRAY, PROP_WRITABLE

Constructor Summary

Constructors
Constructor and Description
`DocumentImpl(java.lang.CharSequence chars)`
`DocumentImpl(java.lang.CharSequence chars, boolean forUseInNonAWTThread)` NOTE: if client sets forUseInNonAWTThread to true it's supposed that client will completely control document and its listeners.
`DocumentImpl(java.lang.CharSequence chars, boolean acceptSlashR, boolean forUseInNonAWTThread)`
`DocumentImpl(java.lang.String text)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsSlashR()`
`void`	`addDocumentListener(DocumentListener listener)` Adds a listener for receiving notifications about changes in the document content.
`void`	`addDocumentListener(DocumentListener listener, Disposable parentDisposable)`
`void`	`addEditReadOnlyListener(EditReadOnlyListener listener)`
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds a listener for receiving notifications about changes in the properties of the document (for example, its read-only state).
`static boolean`	`areRangeMarkersRetainedFor(VirtualFile f)`
`void`	`assertNotInBulkUpdate()`
`void`	`clearLineModificationFlags()`
`void`	`clearLineModificationFlags(int startLine, int endLine)`
`RangeMarker`	`createGuardedBlock(int startOffset, int endOffset)` Marks a range of text in the document as read-only (attempts to modify text in the range cause `ReadOnlyFragmentModificationException` to be thrown).
`LineIterator`	`createLineIterator()`
`RangeMarker`	`createRangeMarker(int startOffset, int endOffset, boolean surviveOnExternalChange)` Creates a range marker which points to the specified range of text in the document and is automatically adjusted when the document text is changed.
`void`	`deleteString(int startOffset, int endOffset)` Deletes the specified range of text from the document.
`void`	`deleteString(int startOffset, int endOffset, int moveDstOffset)`
`void`	`documentCreatedFrom(VirtualFile f)`
`void`	`fireReadOnlyModificationAttempt()` Fires a notification that the user would like to remove the read-only state from the document (the read-only state can be removed by checking the file out from the version control system, or by clearing the read-only attribute on the file).
`FrozenDocument`	`freeze()`
`java.lang.CharSequence`	`getCharsSequence()` Use this method instead of `Document.getText()` if you do not need to create a copy of the content.
`java.util.List<RangeMarker>`	`getGuardedBlocks()`
`java.lang.CharSequence`	`getImmutableCharSequence()`
`int`	`getLineCount()` Returns the number of lines in the document.
`int`	`getLineEndOffset(int line)` Returns the end offset for the line with the specified number.
`int`	`getLineNumber(int offset)` Returns the line number (0-based) corresponding to the specified offset in the document.
`int`	`getLineSeparatorLength(int line)`
`int`	`getLineStartOffset(int line)` Returns the start offset for the line with the specified number.
`int`	`getModificationSequence()`
`long`	`getModificationStamp()` Gets the modification stamp value.
`RangeMarker`	`getOffsetGuard(int offset)` Returns the read-only marker covering the specified offset in the document.
`RangeMarker`	`getRangeGuard(int start, int end)` Returns the read-only marker covering the specified range in the document.
`java.lang.String`	`getText()` Retrieves a copy of the document content.
`java.lang.String`	`getText(TextRange range)`
`int`	`getTextLength()` Returns the length of the document text.
`void`	`insertString(int offset, java.lang.CharSequence s)` Inserts the specified text at the specified offset in the document.
`boolean`	`isInBulkUpdate()`
`boolean`	`isInEventsHandling()`
`boolean`	`isLineModified(int line)`
`boolean`	`isWritable()` Checks if the document text is read-only.
`void`	`moveText(int srcStart, int srcEnd, int dstOffset)` Moves text from the `[srcStart; srcEnd)` range to the `dstOffset` offset.
`boolean`	`processRangeMarkers(Processor<? super RangeMarker> processor)` Get all range markers and hand them to the `processor` in their `RangeMarker.getStartOffset()` order
`boolean`	`processRangeMarkersOverlappingWith(int start, int end, Processor<? super RangeMarker> processor)` Get range markers which `TextRange.intersects(int, int)` the specified range and hand them to the `processor` in their `RangeMarker.getStartOffset()` order
`void`	`registerRangeMarker(RangeMarkerEx rangeMarker, int start, int end, boolean greedyToLeft, boolean greedyToRight, int layer)`
`void`	`removeDocumentListener(DocumentListener listener)` Removes a listener for receiving notifications about changes in the document content, previously added via `Document.addDocumentListener(DocumentListener)`.
`void`	`removeEditReadOnlyListener(EditReadOnlyListener listener)`
`void`	`removeGuardedBlock(RangeMarker block)` Removes a marker marking a range of text in the document as read-only.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes a listener for receiving notifications about changes in the properties of the document (for example, its read-only state).
`boolean`	`removeRangeMarker(RangeMarkerEx rangeMarker)`
`void`	`replaceString(int startOffset, int endOffset, java.lang.CharSequence s)` Replaces the specified range of text in the document with the specified string.
`void`	`replaceString(int startOffset, int endOffset, java.lang.CharSequence s, long newModificationStamp, boolean wholeTextReplaced)`
`void`	`replaceText(java.lang.CharSequence chars, long newModificationStamp)`
`boolean`	`setAcceptSlashR(boolean accept)`
`void`	`setCyclicBufferSize(int bufferSize)` Sets the maximum size of the cyclic buffer used for the document.
`void`	`setInBulkUpdate(boolean value)` Enters or exits 'bulk' mode for processing of document changes.
`void`	`setModificationStamp(long modificationStamp)`
`void`	`setReadOnly(boolean isReadOnly)` Marks the document as read-only or read/write.
`void`	`setStripTrailingSpacesEnabled(boolean isEnabled)`
`void`	`setText(java.lang.CharSequence text)`
`void`	`startGuardedBlockChecking()` Enables checking for read-only markers when the document is modified.
`void`	`stopGuardedBlockChecking()` Disables checking for read-only markers when the document is modified.
`boolean`	`stripTrailingSpaces(Project project)`
`boolean`	`stripTrailingSpaces(Project project, boolean inChangedLinesOnly)`
`void`	`suppressGuardedExceptions()`
`java.lang.String`	`toString()`
`void`	`unSuppressGuardedExceptions()`

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase
changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.editor.Document
createRangeMarker, createRangeMarker, getChars

Methods inherited from interface com.intellij.openapi.util.UserDataHolder
getUserData, putUserData

- Constructor Detail
  - DocumentImpl
```
public DocumentImpl(java.lang.String text)
```
  - DocumentImpl
```
public DocumentImpl(java.lang.CharSequence chars)
```
  - DocumentImpl
```
public DocumentImpl(java.lang.CharSequence chars,
                    boolean forUseInNonAWTThread)
```
    NOTE: if client sets forUseInNonAWTThread to true it's supposed that client will completely control document and its listeners. The noticeable peculiarity of DocumentImpl behavior in this mode is that DocumentImpl won't suppress ProcessCancelledException thrown from listeners during changedUpdate event, so the exception will be rethrown and rest of the listeners WON'T be notified.
  - DocumentImpl
```
public DocumentImpl(java.lang.CharSequence chars,
                    boolean acceptSlashR,
                    boolean forUseInNonAWTThread)
```
- Method Detail
  - documentCreatedFrom
```
public void documentCreatedFrom(VirtualFile f)
```
  - areRangeMarkersRetainedFor
```
public static boolean areRangeMarkersRetainedFor(VirtualFile f)
```
  - setAcceptSlashR
```
public boolean setAcceptSlashR(boolean accept)
```
  - acceptsSlashR
```
public boolean acceptsSlashR()
```
  - setStripTrailingSpacesEnabled
```
public void setStripTrailingSpacesEnabled(boolean isEnabled)
```
    Specified by:
    
    setStripTrailingSpacesEnabled in interface DocumentEx
  - stripTrailingSpaces
```
public boolean stripTrailingSpaces(Project project)
```
  - stripTrailingSpaces
```
public boolean stripTrailingSpaces(Project project,
                                   boolean inChangedLinesOnly)
```
  - isLineModified
```
public boolean isLineModified(int line)
```
    Specified by:
    
    isLineModified in interface Document
    
    Returns:
    
    whether the line with the given index has been modified since the document has been saved
  - setReadOnly
```
public void setReadOnly(boolean isReadOnly)
```
    Description copied from interface: Document
    
    Marks the document as read-only or read/write. This method only modifies the flag stored in the document instance - no checkouts or file changes are performed.
    
    Specified by:
    
    setReadOnly in interface Document
    
    Parameters:
    
    isReadOnly - the new value of the read-only flag.
    
    See Also:
    
    Document.isWritable(), Document.fireReadOnlyModificationAttempt()
  - isWritable
```
public boolean isWritable()
```
    Description copied from interface: Document
    
    Checks if the document text is read-only.
    
    Specified by:
    
    isWritable in interface Document
    
    Returns:
    
    true if the document text is writable, false if it is read-only.
    
    See Also:
    
    Document.fireReadOnlyModificationAttempt()
  - removeRangeMarker
```
public boolean removeRangeMarker(RangeMarkerEx rangeMarker)
```
    Specified by:
    
    removeRangeMarker in interface DocumentEx
  - registerRangeMarker
```
public void registerRangeMarker(RangeMarkerEx rangeMarker,
                                int start,
                                int end,
                                boolean greedyToLeft,
                                boolean greedyToRight,
                                int layer)
```
    Specified by:
    
    registerRangeMarker in interface DocumentEx
  - createGuardedBlock
```
public RangeMarker createGuardedBlock(int startOffset,
                                      int endOffset)
```
    Description copied from interface: Document
    
    Marks a range of text in the document as read-only (attempts to modify text in the range cause ReadOnlyFragmentModificationException to be thrown).
    
    Specified by:
    
    createGuardedBlock in interface Document
    
    Parameters:
    
    startOffset - the start offset of the text range to mark as read-only.
    
    endOffset - the end offset of the text range to mark as read-only.
    
    Returns:
    
    the marker instance.
    
    See Also:
    
    Document.removeGuardedBlock(RangeMarker), Document.startGuardedBlockChecking(), EditorActionManager.setReadonlyFragmentModificationHandler(com.intellij.openapi.editor.actionSystem.ReadonlyFragmentModificationHandler)
  - removeGuardedBlock
```
public void removeGuardedBlock(RangeMarker block)
```
    Description copied from interface: Document
    
    Removes a marker marking a range of text in the document as read-only.
    
    Specified by:
    
    removeGuardedBlock in interface Document
    
    Parameters:
    
    block - the marker to remove.
    
    See Also:
    
    Document.createGuardedBlock(int, int)
  - getGuardedBlocks
```
public java.util.List<RangeMarker> getGuardedBlocks()
```
    Specified by:
    
    getGuardedBlocks in interface DocumentEx
  - getOffsetGuard
```
public RangeMarker getOffsetGuard(int offset)
```
    Description copied from interface: Document
    
    Returns the read-only marker covering the specified offset in the document.
    
    Specified by:
    
    getOffsetGuard in interface Document
    
    Parameters:
    
    offset - the offset for which the marker is requested.
    
    Returns:
    
    the marker instance, or null if the specified offset is not covered by a read-only marker.
  - getRangeGuard
```
public RangeMarker getRangeGuard(int start,
                                 int end)
```
    Description copied from interface: Document
    
    Returns the read-only marker covering the specified range in the document.
    
    Specified by:
    
    getRangeGuard in interface Document
    
    Parameters:
    
    start - the start offset of the range for which the marker is requested.
    
    end - the end offset of the range for which the marker is requested.
    
    Returns:
    
    the marker instance, or null if the specified range is not covered by a read-only marker.
  - startGuardedBlockChecking
```
public void startGuardedBlockChecking()
```
    Description copied from interface: Document
    
    Enables checking for read-only markers when the document is modified. Checking is disabled by default.
    
    Specified by:
    
    startGuardedBlockChecking in interface Document
    
    See Also:
    
    Document.createGuardedBlock(int, int), Document.stopGuardedBlockChecking()
  - stopGuardedBlockChecking
```
public void stopGuardedBlockChecking()
```
    Description copied from interface: Document
    
    Disables checking for read-only markers when the document is modified. Checking is disabled by default.
    
    Specified by:
    
    stopGuardedBlockChecking in interface Document
    
    See Also:
    
    Document.createGuardedBlock(int, int), Document.startGuardedBlockChecking()
  - createRangeMarker
```
public RangeMarker createRangeMarker(int startOffset,
                                     int endOffset,
                                     boolean surviveOnExternalChange)
```
    Description copied from interface: Document
    
    Creates a range marker which points to the specified range of text in the document and is automatically adjusted when the document text is changed. The marker is optionally invalidated by external changes to the document text (for example, reloading the file from disk).
    
    Specified by:
    
    createRangeMarker in interface Document
    
    Parameters:
    
    startOffset - the start offset for the range of text covered by the marker.
    
    endOffset - the end offset for the range of text covered by the marker.
    
    surviveOnExternalChange - if true, the marker is not invalidated by external changes.
    
    Returns:
    
    the marker instance.
  - getModificationStamp
```
public long getModificationStamp()
```
    Description copied from interface: Document
    
    Gets the modification stamp value. Modification stamp is a value changed by any modification of the content of the file. Note that it is not related to the file modification time.
    
    Specified by:
    
    getModificationStamp in interface Document
    
    Returns:
    
    the modification stamp value.
    
    See Also:
    
    PsiFile.getModificationStamp(), VirtualFile.getModificationStamp()
  - setModificationStamp
```
public void setModificationStamp(long modificationStamp)
```
    Specified by:
    
    setModificationStamp in interface DocumentEx
  - replaceText
```
public void replaceText(java.lang.CharSequence chars,
                        long newModificationStamp)
```
    Specified by:
    
    replaceText in interface DocumentEx
  - insertString
```
public void insertString(int offset,
                         java.lang.CharSequence s)
```
    Description copied from interface: Document
    
    Inserts the specified text at the specified offset in the document. Line breaks in the inserted text must be normalized as \n.
    
    Specified by:
    
    insertString in interface Document
    
    Parameters:
    
    offset - the offset to insert the text at.
    
    s - the text to insert.
  - deleteString
```
public void deleteString(int startOffset,
                         int endOffset)
```
    Description copied from interface: Document
    
    Deletes the specified range of text from the document.
    
    Specified by:
    
    deleteString in interface Document
    
    Parameters:
    
    startOffset - the start offset of the range to delete.
    
    endOffset - the end offset of the range to delete.
  - deleteString
```
public void deleteString(int startOffset,
                         int endOffset,
                         int moveDstOffset)
```
  - moveText
```
public void moveText(int srcStart,
                     int srcEnd,
                     int dstOffset)
```
    Description copied from interface: DocumentEx
    
    Moves text from the [srcStart; srcEnd) range to the dstOffset offset.
    The benefit to use this method over usual Document.deleteString(int, int) and Document.replaceString(int, int, CharSequence) is that range markers from the [srcStart; srcEnd) range have a chance to be preserved. Default implementation doesn't preserve range markers, but has the same effect in terms of resulting text content.
    
    Specified by:
    
    moveText in interface DocumentEx
    
    Parameters:
    
    srcStart - start offset of the text to move (inclusive)
    
    srcEnd - end offset of the text to move (exclusive)
    
    dstOffset - the offset to insert the text to. Must be outside of the (srcStart, srcEnd) range.
  - replaceString
```
public void replaceString(int startOffset,
                          int endOffset,
                          java.lang.CharSequence s)
```
    Description copied from interface: Document
    
    Replaces the specified range of text in the document with the specified string. Line breaks in the text to replace with must be normalized as \n.
    
    Specified by:
    
    replaceString in interface Document
    
    Parameters:
    
    startOffset - the start offset of the range to replace.
    
    endOffset - the end offset of the range to replace.
    
    s - the text to replace with.
  - replaceString
```
public void replaceString(int startOffset,
                          int endOffset,
                          java.lang.CharSequence s,
                          long newModificationStamp,
                          boolean wholeTextReplaced)
```
  - suppressGuardedExceptions
```
public void suppressGuardedExceptions()
```
    Specified by:
    
    suppressGuardedExceptions in interface DocumentEx
  - unSuppressGuardedExceptions
```
public void unSuppressGuardedExceptions()
```
    Specified by:
    
    unSuppressGuardedExceptions in interface DocumentEx
  - isInEventsHandling
```
public boolean isInEventsHandling()
```
    Specified by:
    
    isInEventsHandling in interface DocumentEx
  - clearLineModificationFlags
```
public void clearLineModificationFlags()
```
    Specified by:
    
    clearLineModificationFlags in interface DocumentEx
  - clearLineModificationFlags
```
public void clearLineModificationFlags(int startLine,
                                       int endLine)
```
  - getModificationSequence
```
public int getModificationSequence()
```
    Specified by:
    
    getModificationSequence in interface DocumentEx
    
    Returns:
    
    modification stamp. Guaranteed to be strictly increasing on each change unlike the Document.getModificationStamp() which can change arbitrarily.
  - getText
```
public java.lang.String getText()
```
    Description copied from interface: Document
    
    Retrieves a copy of the document content. For obvious performance reasons use Document.getCharsSequence() whenever it's possible.
    
    Specified by:
    
    getText in interface Document
    
    Returns:
    
    document content.
  - getText
```
public java.lang.String getText(TextRange range)
```
    Specified by:
    
    getText in interface Document
  - getTextLength
```
public int getTextLength()
```
    Description copied from interface: Document
    
    Returns the length of the document text.
    
    Specified by:
    
    getTextLength in interface Document
    
    Returns:
    
    the length of the document text.
    
    See Also:
    
    Document.getCharsSequence()
  - getCharsSequence
```
public java.lang.CharSequence getCharsSequence()
```
    Description copied from interface: Document
    
    Use this method instead of Document.getText() if you do not need to create a copy of the content. Content represented by returned CharSequence is subject to change whenever document is modified via delete/replace/insertString method calls. It is necessary to obtain Application.runWriteAction() to modify content of the document though so threading issues won't arise.
    
    Specified by:
    
    getCharsSequence in interface Document
    
    Returns:
    
    inplace document content.
    
    See Also:
    
    Document.getTextLength()
  - getImmutableCharSequence
```
public java.lang.CharSequence getImmutableCharSequence()
```
    Specified by:
    
    getImmutableCharSequence in interface Document
    
    Returns:
    
    a char sequence representing document content that's guaranteed to be immutable. No read- or write-action is necessary.
    
    See Also:
    
    ImmutableCharSequence
  - addDocumentListener
```
public void addDocumentListener(DocumentListener listener)
```
    Description copied from interface: Document
    
    Adds a listener for receiving notifications about changes in the document content.
    
    Specified by:
    
    addDocumentListener in interface Document
    
    Parameters:
    
    listener - the listener instance.
  - addDocumentListener
```
public void addDocumentListener(DocumentListener listener,
                                Disposable parentDisposable)
```
    Specified by:
    
    addDocumentListener in interface Document
  - removeDocumentListener
```
public void removeDocumentListener(DocumentListener listener)
```
    Description copied from interface: Document
    
    Removes a listener for receiving notifications about changes in the document content, previously added via Document.addDocumentListener(DocumentListener). Don't call this method for listeners added via Document.addDocumentListener(DocumentListener, Disposable), as that might cause memory leaks.
    
    Specified by:
    
    removeDocumentListener in interface Document
    
    Parameters:
    
    listener - the listener instance.
  - getLineNumber
```
public int getLineNumber(int offset)
```
    Description copied from interface: Document
    
    Returns the line number (0-based) corresponding to the specified offset in the document.
    
    Specified by:
    
    getLineNumber in interface Document
    
    Parameters:
    
    offset - the offset to get the line number for (must be in the range from 0 to getTextLength()-1)
    
    Returns:
    
    the line number corresponding to the offset.
  - createLineIterator
```
public LineIterator createLineIterator()
```
    Specified by:
    
    createLineIterator in interface DocumentEx
  - getLineStartOffset
```
public final int getLineStartOffset(int line)
```
    Description copied from interface: Document
    
    Returns the start offset for the line with the specified number.
    
    Specified by:
    
    getLineStartOffset in interface Document
    
    Parameters:
    
    line - the line number (from 0 to getLineCount()-1)
    
    Returns:
    
    the start offset for the line.
  - getLineEndOffset
```
public final int getLineEndOffset(int line)
```
    Description copied from interface: Document
    
    Returns the end offset for the line with the specified number.
    
    Specified by:
    
    getLineEndOffset in interface Document
    
    Parameters:
    
    line - the line number (from 0 to getLineCount()-1)
    
    Returns:
    
    the end offset for the line.
  - getLineSeparatorLength
```
public final int getLineSeparatorLength(int line)
```
    Specified by:
    
    getLineSeparatorLength in interface Document
  - getLineCount
```
public final int getLineCount()
```
    Description copied from interface: Document
    
    Returns the number of lines in the document.
    
    Specified by:
    
    getLineCount in interface Document
    
    Returns:
    
    the number of lines in the document.
  - fireReadOnlyModificationAttempt
```
public void fireReadOnlyModificationAttempt()
```
    Description copied from interface: Document
    
    Fires a notification that the user would like to remove the read-only state from the document (the read-only state can be removed by checking the file out from the version control system, or by clearing the read-only attribute on the file).
    
    Specified by:
    
    fireReadOnlyModificationAttempt in interface Document
  - addEditReadOnlyListener
```
public void addEditReadOnlyListener(EditReadOnlyListener listener)
```
    Specified by:
    
    addEditReadOnlyListener in interface DocumentEx
  - removeEditReadOnlyListener
```
public void removeEditReadOnlyListener(EditReadOnlyListener listener)
```
    Specified by:
    
    removeEditReadOnlyListener in interface DocumentEx
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: Document
    
    Adds a listener for receiving notifications about changes in the properties of the document (for example, its read-only state).
    
    Specified by:
    
    addPropertyChangeListener in interface Document
    
    Parameters:
    
    listener - the listener instance.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: Document
    
    Removes a listener for receiving notifications about changes in the properties of the document (for example, its read-only state).
    
    Specified by:
    
    removePropertyChangeListener in interface Document
    
    Parameters:
    
    listener - the listener instance.
  - setCyclicBufferSize
```
public void setCyclicBufferSize(int bufferSize)
```
    Description copied from interface: Document
    
    Sets the maximum size of the cyclic buffer used for the document. If the document uses a cyclic buffer, text added to the end of the document exceeding the maximum size causes text to be removed from the beginning of the document.
    
    Specified by:
    
    setCyclicBufferSize in interface Document
    
    Parameters:
    
    bufferSize - the cyclic buffer size, or 0 if the document should not use a cyclic buffer.
  - setText
```
public void setText(java.lang.CharSequence text)
```
    Specified by:
    
    setText in interface Document
  - isInBulkUpdate
```
public final boolean isInBulkUpdate()
```
    Specified by:
    
    isInBulkUpdate in interface Document
    
    See Also:
    
    Document.setInBulkUpdate(boolean)
  - setInBulkUpdate
```
public final void setInBulkUpdate(boolean value)
```
    Description copied from interface: Document
    
    Enters or exits 'bulk' mode for processing of document changes. Bulk mode should be used when a large number of document changes are applied in batch (without user interaction for each change), to improve performance. E.g. this mode is sometimes used by the platform code during code formatting. In this mode some activities that usually happen on each document change will be muted, with reconciliation happening on bulk mode exit.
    As the reconciliation after exiting bulk mode implies some additional overhead, bulk mode shouldn't be used if the number of document changes to be performed is relatively small. The number of changes which justifies switching to bulk mode is usually determined empirically, but typically it's around hundred(s) of changes.
    In bulk mode editor(s) associated with the document will stop updating internal caches on each document change. As a result, certain operations with editor can return invalid results or lead to exception, if they are preformed in bulk mode. They include: querying or updating folding or soft wrap data, editor position recalculation functions (offset to logical position, logical to visual position, etc), querying or updating caret position or selection state.
    Bulk mode shouldn't span more than one thread or EDT event. Typically it should turned on/off in a try/finally statement.
    
    Specified by:
    
    setInBulkUpdate in interface Document
    
    See Also:
    
    DocumentUtil.executeInBulk(Document, boolean, Runnable), BulkAwareDocumentListener
  - processRangeMarkers
```
public boolean processRangeMarkers(Processor<? super RangeMarker> processor)
```
    Description copied from interface: DocumentEx
    
    Get all range markers and hand them to the processor in their RangeMarker.getStartOffset() order
    
    Specified by:
    
    processRangeMarkers in interface DocumentEx
  - processRangeMarkersOverlappingWith
```
public boolean processRangeMarkersOverlappingWith(int start,
                                                  int end,
                                                  Processor<? super RangeMarker> processor)
```
    Description copied from interface: DocumentEx
    
    Get range markers which TextRange.intersects(int, int) the specified range and hand them to the processor in their RangeMarker.getStartOffset() order
    
    Specified by:
    
    processRangeMarkersOverlappingWith in interface DocumentEx
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - freeze
```
public FrozenDocument freeze()
```
  - assertNotInBulkUpdate
```
public void assertNotInBulkUpdate()
```

Class DocumentImpl

Field Summary

Fields inherited from interface com.intellij.openapi.editor.Document

Constructor Summary

Method Summary

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.openapi.editor.Document

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

Constructor Detail

DocumentImpl

DocumentImpl

DocumentImpl

DocumentImpl

Method Detail

documentCreatedFrom

areRangeMarkersRetainedFor

setAcceptSlashR

acceptsSlashR

setStripTrailingSpacesEnabled

stripTrailingSpaces

stripTrailingSpaces

isLineModified

setReadOnly

isWritable

removeRangeMarker

registerRangeMarker

createGuardedBlock

removeGuardedBlock

getGuardedBlocks

getOffsetGuard

getRangeGuard

startGuardedBlockChecking

stopGuardedBlockChecking

createRangeMarker

getModificationStamp

setModificationStamp

replaceText

insertString

deleteString

deleteString

moveText

replaceString

replaceString

suppressGuardedExceptions

unSuppressGuardedExceptions

isInEventsHandling

clearLineModificationFlags

clearLineModificationFlags

getModificationSequence

getText

getText

getTextLength

getCharsSequence

getImmutableCharSequence

addDocumentListener

addDocumentListener

removeDocumentListener

getLineNumber

createLineIterator

getLineStartOffset

getLineEndOffset

getLineSeparatorLength

getLineCount

fireReadOnlyModificationAttempt

addEditReadOnlyListener

removeEditReadOnlyListener

addPropertyChangeListener

removePropertyChangeListener

setCyclicBufferSize

setText

isInBulkUpdate

setInBulkUpdate

processRangeMarkers

processRangeMarkersOverlappingWith

toString

freeze

assertNotInBulkUpdate