Introduction

What do the Dates Mean?

The supplied dates indicate when the API change was made, on the CVS trunk. From this you can generally tell whether the change should be present in a given build or not; for trunk builds, simply whether it was made before or after the change; for builds on a stabilization branch, whether the branch was made before or after the given date. In some cases corresponding API changes have been made both in the trunk and in an in-progress stabilization branch, if they were needed for a bug fix; this ought to be marked in this list.


Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.lexer/1 > 1.20

Changes by affected class


Details of all changes by API and date


Lexer API

Joined Sections Lexing

May 28 '08; API spec. version: 1.28; made by: mmetelka; issues: #117450

Embeddings that request input sections to be joined before lexing are now lexed as a single section.
Token.isRemoved() was added to check whether a particular token is still present in token hierarchy or whether it was removed as part of a modification.

Lexer API Cleanup

Nov 5 '07; API spec. version: 1.25; made by: mmetelka; issues: #120052

Support for token hierarchy snapshots and generic character preprocessing was removed from the API and SPI since there were no usecases yet and it should be possible to add the functionality later in a backward compatible way. Some more changes regarding generification etc. were performed.

Removing LexerInput.integerState

Nov 3 '07; API spec. version: 1.24; made by: vstejskal; issues: #88641

LexerInput.integerState() was removed.

Possibility to remove a previously created custom embedding

Oct 5 '07; API spec. version: 1.23; made by: mmetelka; issues: #94365

TokenSequence.removeEmbedding() was added as counterpart to TokenSequence.createEmbedding().
Also TokenSequence.isValid() was added to check whether the token sequence can be used for iteration (no modifications of the underlying input in the meantime).

Support for embeddings that join sections

Aug 30 '07; API spec. version: 1.22; made by: mmetelka; issues: #87014

Joining sections embeddings now supported and some minor changes were introduced like adding LanguagePath.parent(). Some is* methods with trivial implementations were removed from LanguagePath. TokenChange.embeddedChange(Language) was removed because there might be multiple such changes and they can be gathered with existing methods.


Binary-compatible

Added LanguageHierarchy.embeddingPresence()

Aug 17 '07; API spec. version: 1.21; made by: mmetelka; issues: #112465

Added LanguageHierarchy.embeddingPresence() method and EmbeddingPresence enum to speed up queries for embedded token sequences.

Added TokenHierarchy.embeddedTokenSequences

Jun 5 '07; API spec. version: 1.20; made by: vstejskal

Added TokenHierarchy.embeddedTokenSequences method.

Removed previously added Language.refresh().

May 16 '07; API spec. version: 1.19; made by: mmetelka; issues: #102435

Removed previously added Language.refresh() since there is an alternative in using LanguageProvider.firePropertyChange(PROP_LANGUAGE).


Binary-compatible

Added Language.refresh().

Apr 27 '07; API spec. version: 1.18; made by: mmetelka; issues: #102435

Added Language.refresh() to allow languages framework and other clients to update contents of a language dynamically.

Added TokenHierarchy.tokenSequenceList().

Apr 13 '07; API spec. version: 1.17; made by: mmetelka; issues: #95569

Added TokenHierarchy.tokenSequenceList() to find token sequences having certain language path throughout the whole input source or just within given offset bounds.
Also added LanguagePath.embedded(language) and LanguagePath.embedded(suffixLanguagePath).

Added TokenChange.isBoundsChange().

Mar 23 '07; API spec. version: 1.16; made by: mmetelka; issues: #93644

Added TokenChange.isBoundsChange() to check for changes that only modify token bounds (see method's javadoc).
Improved incrementality for embedded sections for bounds changes.

Added PartType for token parts support

Mar 1 '07; API spec. version: 1.14; made by: mmetelka; issues: #91184

Added PartType enum and Token.partType() that identifies whether the token is COMPLETE or which part of a complete token this part represents (START, INNER or END).


Binary-compatible

Changed TokenSequence.move() and moveIndex() use

Jan 16 '07; API spec. version: 1.13; made by: mmetelka; issues: #90796

Changed the TokenSequence.move() to position before the particular token that "contains" the offset (or after the last token if the given offset is too high). Additional moveNext() is necessary to actually move to the next token.
TokenSequence.moveIndex() was modified in a similar way (see javadocs).
TokenSequence.moveFirst() and moveLast() were replaced by moveStart() that positionins before the first token and by moveEnd() that positions after the last token.
TokenSequence.isEmpty() added to check whether there are no tokens in the TS.


Binary-compatible

Added Lexer.release()

Dec 7 '06; API spec. version: 1.12; made by: mmetelka; issues: #89000

Added Lexer.release() useful for lexer instances caching.


Binary-compatible

Adding custom embedding creation TokenSequence.createEmbedding()

Nov 23 '06; API spec. version: 1.11; made by: mmetelka; issues: #86473

Extracted TokenHierarchyEvent.Type inner class into TokenHierarchyEventType top-level class.
Adding TokenSequence.createEmbedding() method for creation of a custom embedding. TokenHierarchyEventType.EMBEDDING fired after embedding creation.
Affected offset information (affectedStartOffset() and affectedEndOffset()) moved from TokenChange to TokenHierarchyEvent
There can be now more than one embedded change in a TokenChange.
Removed tokenComplete parameter from LanguageHierarchy.embedding() because the token incompletness will be handled in a different way.
Swapped order of token and languagePath parameters in LanguageProvider to be in sync with LanguageHierarchy.embedding().
LanguageEmbedding is now a final class (instead of abstract class) with private constructor and static create() method. That allows better control over the evolution of the class and it also allows to cache the created embeddings to save memory.
LanguageEmbedding is now generified with the T extends TokenId which is a generification of the language which it contains.
TokenHierarchy.languagePaths() set contains all language paths used in the token hierarchy. TokenHierarchyEventType.LANGUAGE_PATHS fired after change of that set.


Binary-compatible

Adding LanguageDescription.find(String mimePath)

Oct 18 '06; API spec. version: 1.10; made by: vstejskal

Adding the LanguageDescription.find(String mimePath) method, which can be used for looking up LanguageDescriptions by their mime types.

Improved generification

Oct 11 '06; API spec. version: 1.8; made by: mmetelka

Generification of methods of LanguagePath, TokenSequence and other classes has been improved.


Binary-compatible

Rebuilt the API and SPI completely

May 5 '06; API spec. version: 1.4; made by: mmetelka

The original API and SPI were rebuilt completely (under editor_api branch) to comply with the standard requirements for the NetBeans APIs and allow for better API evolution in the future.
The major version of the lexer module was increased to 2.


Binary-compatible

Added LexerInput.getReadText() and LexerInput.isEOFLookahead()

May 16 '03; API spec. version: 1.3; made by: mmetelka
There were two methods added into org.netbeans.api.lexer.LexerInput:

LexerInput.backup(int count) now accepts negative values too to redo character backups.

These methods are necessary for more efficient handling of the input.

Unfortunately this change is incompatible as the LexerInput is interface.

Added LexerInput.getReadLength() and LexerInput.createToken(TokenId, tokenLength) and renamed TokenTextMatcher to SampleTextMatcher

Sep 20 '02; API spec. version: 1.2; made by: mmetelka
There were two methods added into org.netbeans.api.lexer.LexerInput: These methods are necessary for efficient support of the Antlr lexers.
Unfortunately this change is incompatible as the LexerInput is interface.

The TokenTextMatcher was renamed to SampleTextMatcher which should be better name than the original one. Documentation was also updatged. It should be now more clear that there can be zero or more samples for the text of each token and that the SampleTextMatcher encapsulates the given samples and can check whether the token's text matches one of them.


Lexer SPI

LanguageProvider.findEmbeddedLanguage() changed to findLanguageEmbedding

Oct 12 '06; API spec. version: 1.9; made by: vstejskal

LanguageProvider.findEmbeddedLanguage() method signature was changed. The method is now called findLanguageEmbedding and returns LanguageEmbedding instead of just LanguageDescription.


Binary-compatible

TokenSequence.moveOffset() renamed to move()

Sep 18 '06; API spec. version: 1.7; made by: mmetelka

TokenSequence.moveOffset() was renamed to TokenSequence.move(). The original TokenSequence.move() which is seldom used was renamed to TokenSequence.moveIndex().


Binary-compatible

Added LanguageProvider

Sep 14 '06; API spec. version: 1.6; made by: vstejskal

The LanguageProvider class was added to the SPI package. It is possible to register instances of this class in the default lookup. The lexer module will use them to find LanguageDescriptions for documents ( according to their mime types) and for tokens, which contain embedded language.

Removed TokenIdFilter and TokenHandler

Aug 30 '06; API spec. version: 1.5; made by: mmetelka

The TokenIdFilter class was removed from the API. Instead of it Set<? extends TokenId> should be used where appropriate.
With the TokenFactory now being final the TokenHandler is no longer needed. The few remaining overridable SPI methods were moved to LanguageHierarchy and the TokenHandler class was removed.
LanguagePath and InputAttributes parameters were added to LanguageHierarchy.createLexer() (to the end of the existing parameters) in order to allow the lexer to react to input attributes.
For consistency the parameters of LanguageHierarchy.embedding() were reordered so that the LanguagePath and InputAttributes parameters are also at the end of the list and in the same order.


Binary-compatible

Lexer Swing API

Added swing subpackage to API

Sep 20 '02; API spec. version: 1.1; made by: mmetelka

That API subpackage will contain swing-related API of the lexer in the org.netbeans.api.lexer.swing package.
I have removed Language.find(String mimeType) - it never worked.
I have added Language.getValidId(int intId).
The whole API and implementation was moved from libsrc to src (libsrc is now abandoned) in order to better adhere to module conventions.