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

• Indexing API

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.

• (Apr 20 '14) Indexing API separated to its own module

All changes by date

• (Sep 14 '21) Allow plugins to exclude files from being indexed.
• (Jul 28 '21) Allow Parsers to adjust results for indexing
• (Apr 14 '15) Added custom camel case support into QuerySupport
• (Apr 20 '14) Indexing API separated to its own module

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

• (9.24) Allow plugins to exclude files from being indexed.
• (9.22) Allow Parsers to adjust results for indexing
• (9.5) Added custom camel case support into QuerySupport
• (9.0) Indexing API separated to its own module

Changes by affected class

org.netbeans.modules.parsing.spi.indexing.IndexabilityQueryImplementation

• (Sep 14 '21) Allow plugins to exclude files from being indexed.

org.netbeans.modules.parsing.spi.indexing.support.IndexingSupport

• (Jul 28 '21) Allow Parsers to adjust results for indexing

org.netbeans.modules.parsing.spi.indexing.support.QuerySupport

• (Apr 14 '15) Added custom camel case support into QuerySupport

Details of all changes by API and date

Indexing API

Allow plugins to exclude files from being indexed.

There are situations where it is desireable to exclude files from the NetBeans indexing infrastructure. Implementors of IndexabilityQueryImplementation are queried whether an indexer should be invoked for a given file.

Indexing for a file can be rejected verbatim (boolean preventIndexing(FileObject fo)) or more specific by indexer name, URL to the file to be indexed and the UTL of the indexing root. boolean preventIndexing(String indexerName, URL indexable, URL rootUrl).

One such example are Angular projects, where code assistence is provided by the typescript integration by the language server. In these cases the node_modules folder often contains huge amounts of javascript code, that the IDE user does not need to be indexed, but which take a lot of time to parse. A hypothetical plugin could check if an angular.json file is present and then prevent the js indexer from indexing files in the node_modules directory.

Allow Parsers to adjust results for indexing

Parsers may need to provide reduced data for indexing, or enriched data for source parsing. The added isIndexingTask() method identifies tasks applied by indexing infrastructure.

Added custom camel case support into QuerySupport

Added a support for custom camel case separators and custom camel case parts into QuerySupport

Indexing API separated to its own module

Historically the module offered both APIs for Parsing (invoking parser, implementing parser) and Indexing (refresh index, index SPIs). Those APIs are typically used by unrelated pieces of code, possibly with the exception of "refresh" actions.

The indexing now resides separately in its parsing.indexing module. Binary compatibility is kept by using module-auto-deps.xml.

Please also refer to the API Changes document of the parental module.