org.netbeans.api.lexer

Class TokenChange<T extends TokenId>

java.lang.Object

org.netbeans.api.lexer.TokenChange<T>

public final class TokenChange<T extends TokenId>
extends Object

Token change describes modification on one level of a token hierarchy.
If there is only one token that was modified and there was a language embedding in that token then most of the embedded tokens can usually be retained. This defines an embedded change accessible by TokenChange.embeddedChange(int).
There may possibly be multiple levels of the embedded changes.

Method Summary

Modifier and Type	Method and Description
int	addedTokenCount() Get number of the tokens added by this token change.
TokenSequence<T>	currentTokenSequence() Get the token sequence that corresponds to the current state of the token hierarchy.
TokenChange<?>	embeddedChange(int index) Get embedded change at the given index.
int	embeddedChangeCount() Get number of embedded changes contained in this change.
int	index() Get index of the first token being modified.
boolean	isBoundsChange() Whether this change only modifies bounds of a single token.
Language<T>	language() Get the language describing token ids used by tokens contained in this token change.
LanguagePath	languagePath() Get the complete language path of the tokens contained in this token sequence (containing outer language levels as well).
int	offset() Get offset of the first token that was modified.
int	removedTokenCount() Get number of removed tokens contained in this token change.
TokenSequence<T>	removedTokenSequence() Create token sequence over the removed tokens.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

embeddedChangeCount

public int embeddedChangeCount()

Get number of embedded changes contained in this change.

Returns:

>=0 number of embedded changes.

embeddedChange

public TokenChange<?> embeddedChange(int index)

Get embedded change at the given index.

Parameters:

index - 0 <= index <= embeddedChangeCount() index of the embedded change.

Returns:

non-null embedded token change.

language

public Language<T> language()

Get the language describing token ids used by tokens contained in this token change.

languagePath

public LanguagePath languagePath()

Get the complete language path of the tokens contained in this token sequence (containing outer language levels as well).

index

public int index()

Get index of the first token being modified.

offset

public int offset()

Get offset of the first token that was modified.
If there were any added/removed tokens then this is a start offset of the first added/removed token.

removedTokenCount

public int removedTokenCount()

Get number of removed tokens contained in this token change.

removedTokenSequence

public TokenSequence<T> removedTokenSequence()

Create token sequence over the removed tokens.

There is no analogy of this method for the added tokens. The TokenChange.currentTokenSequence() may be used for exploration of the current token sequence at this level.

Returns:

token sequence over the removed tokens or null if there were no removed tokens.

addedTokenCount

public int addedTokenCount()

Get number of the tokens added by this token change.

currentTokenSequence

public TokenSequence<T> currentTokenSequence()

Get the token sequence that corresponds to the current state of the token hierarchy.
The token sequence will be positioned at the TokenChange.index().
If this is an embedded token change then this method returns the token sequence at the corresponding embedded level.

isBoundsChange

public boolean isBoundsChange()

Whether this change only modifies bounds of a single token.
This flag is only set if there was a single token removed and a new single token added with the same token id in terms of this change.
For bounds changes the affected offsets of the event will only cover the modified characters (not the modified tokens boundaries).

toString

public String toString()

Overrides:

toString in class Object