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: $codebase > 1.20

Changes by affected class


Details of all changes by API and date


Parsing API

IndexingManager extended to support integration with VCS

Oct 1 '09; API spec. version: 1.24; made by: vstejskal; issues: #167098

Added IndexingManager.refreshAllIndices(boolean fullRescan, boolean wait, File... filesOrFolders), <T> T IndexingManager.runProtected(Callable<T> operation)

Added IndexingManager.refreshAllIndices(boolean fullRescan, boolean wait, FileObject... folders)

Sep 7 '09; API spec. version: 1.23; made by: vstejskal; issues: #168237

Added refreshAllIndices(boolean fullRescan, boolean wait, FileObject... folders).

Added IndexingSupport.createDocument(FileObject) and IndexResult.getIndexable()

Sep 1 '09; API spec. version: 1.22; made by: tzezula

Added methods IndexingSupport.createDocument(FileObject) and IndexResult.getIndexable() in order to allow CustomIndexers and BinaryIndexers to use IndexingSupport.

Added a method for checking an index validity

Aug 24 '09; API spec. version: 1.21; made by: tzezula

Added a method for checking an index validity. The method should be called by IndexerFactories to check the index integrity and prevent exceptions during the run on the IDE when the index is broken (for example the IDE was killed during write to the index).

Added methods scanStarted and scanFinished. Moved up common methods of EmbeddingIndexerFactory and CustomIndexerFactory

Aug 19 '09; API spec. version: 1.20; made by: tzezula

Added scanStarted and scanFinished methods for notifying indexers about start and finish of the indexing of given root. Refactored EmbeddingIndexerFactory and CustomIndexerFactory to move up common methods into super class SourceIndexerFactory.

Notifying indexers about unused roots

Aug 12 '09; API spec. version: 1.19; made by: tzezula

Modified CustomIndexerFactory, EmbeddingIndexerFactory and BinaryIndexerFactory to have a method rootsRemoved(Iterable<? extends URL>).This method is used to notify indexers about unused roots. Indexers may do a clean up of memory caches or close indexes.

Modifying CustomIndexerFactory and EmbeddingIndexerFactory

Jul 3 '09; API spec. version: 1.18; made by: vstejskal; issues: #166340

Modified CustomIndexerFactory and EmbeddingIndexerFactory to have methods filesDeleted(Iterable<? extends Indexable> deleted, Context context); and filesDirty(Iterable<? extends Indexable> deleted, Context context);.

These two methods supersede thier older version, which accepted Collection rather than Iterable. The new methods allow the infrastructure to optimize files crawling and improve the overall performance of scanning.

Adding Context.isSourceForBinaryRootIndexing()

Jun 23 '09; API spec. version: 1.17; made by: vstejskal

Added Context.isSourceForBinaryRootIndexing() in order to further optimize java indexing.

Adding IndexingManager.refreshIndex methods with forceRefresh parameter

Jun 10 '09; API spec. version: 1.16; made by: vstejskal

Added IndexingManager.refreshIndex(URL root, Collection<? extends URL> files, boolean forceRefresh) and IndexingManager.refreshIndexAndWait(URL root, Collection<? extends URL> files, boolean forceRefresh).

Tweaking Indexable and Context

May 21 '09; API spec. version: 1.13; made by: vstejskal

Added Indexable.getMimeType(), Context.isCancelled(). Removed Indexabe.getName(), Indexable.getLastModified(), Indexable.openInputStream().

Fixing typo: IndexingManager.refreshAllIndices()

Apr 20 '09; API spec. version: 1.12; made by: vstejskal

Fixing typo in IndexingManager.refreshAllIndicies(String) method name. Technically this method was removed and a new one called IndexingManager.refreshAllIndices(String) was created. The same happened for IndexingManager.refreshAllIndicies(FileObject...).

Adding Context.checkForEditorModifications

Apr 15 '09; API spec. version: 1.10; made by: vstejskal

Adding Context.checkForEditorModifications() in order to signal indexers whether they should or should not care about editor documents.

Adding IndexResult.getRoot and getRelativePath

Apr 2 '09; API spec. version: 1.9; made by: vstejskal

Adding IndexResult.getRoot() and IndexResult.getRelativePath() methods.

Adding IndexingManager.refreshAllIndicies()

Mar 27 '09; API spec. version: 1.8; made by: vstejskal

Adding IndexingManager.refreshAllIndicies(String) method for refreshing all indices created by a given indexer.

Adding QuerySupport.findRoots(...) methods

Mar 27 '09; API spec. version: 1.7; made by: vstejskal

Adding two QuerySupport.findRoots(...) methods that can be used for finding classpath roots from classpaths marked with specific IDs and supplied by specific project.

Adding IndexingManager.refreshIndexAndWait()

Mar 2 '09; API spec. version: 1.6; made by: vstejskal

Adding IndexingManager.refreshIndexAndWait(URL, Collection<? extends URL>) for synchronous index refreshing.

Support for marking files dirty

Mar 1 '09; API spec. version: 1.4; made by: vstejskal

Adding CustomIndexerFactory.filesDirty, EmbeddingIndexerFactory.filesDirty and IndexingSupport.markDirtyDocuments in order to support on-the-fly reindexing of files modified in the editor.

Support for explicit index refreshing

Feb 26 '09; API spec. version: 1.6; made by: vstejskal

Adding IndexingManager class, which allows requesting to reindex a set of files. Also adding addSupplemntaryFiles and isSupplementaryFilesIndexing methods to Context class in order to allow indexers to request reindexing of additional files.

Adding Context.addIndexingJob

Feb 25 '09; API spec. version: 1.2; made by: vstejskal

Adding Snapshot.getTokenHierarchy

Feb 20 '09; API spec. version: 1.1; made by: vstejskal

Adding Snapshot.getTokenHierarchy() in order to provide effective way for accessing lexer tokens created from a Snapshot.

Parsing API created

Jan 1 '09; API spec. version: 1.0; made by: jjancura; issues: #133900

Creating Parsing API.


Built on November 22 2009.  |  Portions Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved.