Package com.intellij.openapi.editor.impl

Class TextChangesStorage

java.lang.Object

com.intellij.openapi.editor.impl.TextChangesStorage

public class TextChangesStorage
extends java.lang.Object

Allows to store and retrieve TextChange objects assuming that they are applied to the same text.

Provides ability to automatic merging them if necessary.

Not thread-safe.

Constructor Summary

Constructors

Constructor and Description
TextChangesStorage()

Method Summary

Modifier and Type	Method and Description
char	charAt(char [] originalData, int index) Allows to retrieve character for the given index assuming that it should be resolved against 'client text', i.e.
void	clear()
java.util.List<TextChangeImpl>	getChanges()
java.util.List<? extends TextChange>	getChanges(int start, int end) Allows to ask the storage for the list of changes that have intersections with the target text range (identified by the given arguments).
boolean	isEmpty()
int	size()
void	store(TextChange change) Store given change merging it with previously stored ones if necessary.
java.lang.CharSequence	substring(char [] originalData, int start, int end) Allows to build substring of the client text with its changes registered within the current storage.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextChangesStorage

public TextChangesStorage()

Method Detail

getChanges

public java.util.List<TextChangeImpl> getChanges()

Returns:

list of changes stored previously via store(TextChange). Note that the changes offsets relate to initial text and that returned list is sorted by start offset in ascending order

See Also:

store(TextChange)

getChanges

public java.util.List<? extends TextChange> getChanges(int start,
                                                       int end)

Allows to ask the storage for the list of changes that have intersections with the target text range (identified by the given arguments).

Parameters:

start - target range start offset (inclusive)

end - target range end offset (exclusive)

Returns:

list that contains all registered changes that have intersections with the target text range

isEmpty

public boolean isEmpty()

clear

public void clear()

size

public int size()

store

public void store(TextChange change)

Store given change merging it with previously stored ones if necessary.

Note: it's assumed that given change offsets are related to the current state of the text ('client text'), i.e. with all stored changes applied to it. Example:

1. Say, we have initial text '12345';
2. Suppose the change 'replace text at [2; 3) range with 'ABC'' is applied to it (stored at the current object). End-users see the text '12ABC45' now;
3. This method is called with change like 'replace text at [1; 6) range with 'XY''. Change range is assumed to be related to the text visible to end-user, not initial one ('12ABC45', not '12345'). I.e. the user will see text '1XY5' now;

Parameters:

change - change to store

charAt

public char charAt(char [] originalData,
                   int index)

Allows to retrieve character for the given index assuming that it should be resolved against 'client text', i.e. the text contained at the given original char sequence with all registered changes applied to it.

Example:

 

   
Consider that original text is  '01234';
   

     Consider that two changes are registered:  'insert text 'a' at index 1' and
      'insert text 'bc' at index 3';
   
   
 'client text' now is  '0a12bc34';
   
This method is called with index '5' - symbol 'c' is returned;
 
 

Parameters:

originalData - original text to which registered changes are applied

index - target symbol index (is assumed to be 'client text' index)

Returns:

'client text' symbol at the given index

substring

public java.lang.CharSequence substring(char [] originalData,
                                        int start,
                                        int end)

Allows to build substring of the client text with its changes registered within the current storage.

Parameters:

originalData - original text to which registered changes are applied

start - target substring start offset (against the 'client text'; inclusive)

end - target substring end offset (against the 'client text'; exclusive)

Returns:

substring for the given text range

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object