Package com.intellij.openapi.editor.impl

Class TextChangeImpl

java.lang.Object

com.intellij.openapi.editor.impl.TextChangeImpl

All Implemented Interfaces:

TextChange

public class TextChangeImpl
extends java.lang.Object
implements TextChange

Default TextChange implementation with mutable state.

Constructor Summary

Constructors

Constructor and Description
TextChangeImpl(java.lang.CharSequence text, int start) Shorthand for creating change object with the given arguments where 'end index' has the same value as 'start index'.
TextChangeImpl(java.lang.CharSequence text, int start, int end) Creates new TextChange object with the given arguments.

Method Summary

Modifier and Type	Method and Description
void	advance(int offset) Applies given offset applied to the start and end properties of current text change object.
boolean	equals(java.lang.Object o)
char []	getChars() Allows to get change text as a char array.
int	getDiff() Difference in document symbols number after current change appliance.
int	getEnd()
int	getStart()
java.lang.CharSequence	getText() Allows to retrieve text that is directly affected by the change encapsulated by the current object.
int	hashCode()
void	setEnd(int end)
void	setStart(int start)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextChangeImpl

public TextChangeImpl(java.lang.CharSequence text,
                      int start)
               throws java.lang.IllegalArgumentException

Shorthand for creating change object with the given arguments where 'end index' has the same value as 'start index'.

Parameters:

text - text affected by the current change

start - start index (inclusive) of text range affected by the change encapsulated by the current object

Throws:

java.lang.IllegalArgumentException - if given start index is invalid

TextChangeImpl

public TextChangeImpl(java.lang.CharSequence text,
                      int start,
                      int end)
               throws java.lang.IllegalArgumentException

Creates new TextChange object with the given arguments. It encapsulates information about the change that may be applied to the target document.

Parameters:

text - text that is introduced by the current change

start - start index of the target document location where current change is to be applied

end - end index of the target document where current change is to be applied, i.e. it's assumed that current text change appliance to particular document causes replacement of its original text at [start; end) interval by the text encapsulated by the current change. I.e. original text is replaced by the new one

Throws:

java.lang.IllegalArgumentException - if given start or end index in invalid or they are inconsistent to each other

Method Detail

getStart

public int getStart()

Specified by:

getStart in interface TextChange

Returns:

start index (inclusive) of text range affected by the change encapsulated at the current object

setStart

public void setStart(int start)

getEnd

public int getEnd()

Specified by:

getEnd in interface TextChange

Returns:

end index (exclusive) of text range affected by the change encapsulated at the current object

setEnd

public void setEnd(int end)

getText

public java.lang.CharSequence getText()

Allows to retrieve text that is directly affected by the change encapsulated by the current object.

Specified by:

getText in interface TextChange

Returns:

text related to the change encapsulated by the current object

getChars

public char [] getChars()

Allows to get change text as a char array. Note that it's not guaranteed that change text directly maps to the returned char array, i.e. change to array content is not obeyed to be reflected in getText() result.

Generally speaking, this method is introduced just as a step toward existing high-performance services that work in terms of char arrays. Resulting array is instantiated on-demand via CharArrayUtil.fromSequence(CharSequence), hence, it doesn't hit memory if, for example, CharSequenceBackedByArray is used as initial change text.

Specified by:

getChars in interface TextChange

Returns:

stored change text as a char array

getDiff

public int getDiff()

Difference in document symbols number after current change appliance.

Note: returned number may be either positive or not. For example it may be negative for 'remove' or 'replace' changes (number of text symbols is less than number of symbols at target change interval)

Returns:

difference in document symbols number after current change appliance

advance

public void advance(int offset)
             throws java.lang.IllegalArgumentException

Applies given offset applied to the start and end properties of current text change object.

Parameters:

offset - offset to apply to the current change object

Throws:

java.lang.IllegalArgumentException - if start index becomes zero after given offset appliance (it is not applied then)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object