Introduction

This document lists changes made to the Project Libraries API.

Index of APIs

Project Libraries 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.

All changes by date

(Jun 16 '11) Allow user created library to provide display name
(Mar 14 '11) Added a name of the properties property into LibraryImplementation3
(Mar 13 '11) Allow Library to provide properties
(Mar 27 '08) URI used for relative library entries instead of URL
(Jan 22 '08) Support for project libraries
(Aug 31 '07) Customizer for volume type in LibraryTypeProvider is not mandatory
(Aug 11 '06) Added methods for adding and removing libraries into/from library manager
(Dec 22 '04) Switched to major release version 1

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.project.libraries/1 > 1.20

(1.35) Added a name of the properties property into LibraryImplementation3
(1.34) Allow Library to provide properties
(1.31) Allow user created library to provide display name
(1.18) URI used for relative library entries instead of URL
(1.17) Support for project libraries
(1.15) Customizer for volume type in LibraryTypeProvider is not mandatory
(1.14) Added methods for adding and removing libraries into/from library manager
(1.10) Switched to major release version 1

Changes by affected class

`org.netbeans.spi.project.libraries.ArealLibraryProvider`

(Jan 22 '08) Support for project libraries

`org.netbeans.api.project.libraries.LibrariesCustomizer`

(Mar 27 '08) URI used for relative library entries instead of URL
(Jan 22 '08) Support for project libraries

`org.netbeans.spi.project.libraries.support.LibrariesSupport`

(Mar 27 '08) URI used for relative library entries instead of URL
(Jan 22 '08) Support for project libraries
(Aug 11 '06) Added methods for adding and removing libraries into/from library manager

`org.netbeans.api.project.libraries.Library`

(Mar 14 '11) Added a name of the properties property into LibraryImplementation3
(Mar 13 '11) Allow Library to provide properties
(Mar 27 '08) URI used for relative library entries instead of URL
(Jan 22 '08) Support for project libraries

`org.netbeans.api.project.libraries.LibraryChooser`

(Jan 22 '08) Support for project libraries

`org.netbeans.spi.project.libraries.LibraryCustomizerContext`

(Mar 27 '08) URI used for relative library entries instead of URL

`org.netbeans.spi.project.libraries.LibraryFactory`

(Aug 11 '06) Added methods for adding and removing libraries into/from library manager

`org.netbeans.spi.project.libraries.LibraryImplementation2`

(Mar 27 '08) URI used for relative library entries instead of URL

`org.netbeans.spi.project.libraries.LibraryImplementation3`

(Mar 14 '11) Added a name of the properties property into LibraryImplementation3
(Mar 13 '11) Allow Library to provide properties

`org.netbeans.api.project.libraries.LibraryManager`

(Jun 16 '11) Allow user created library to provide display name
(Mar 27 '08) URI used for relative library entries instead of URL
(Jan 22 '08) Support for project libraries
(Aug 11 '06) Added methods for adding and removing libraries into/from library manager

`org.netbeans.spi.project.libraries.LibraryProvider`

(Jan 22 '08) Support for project libraries

`org.netbeans.spi.project.libraries.LibraryStorageArea`

(Jan 22 '08) Support for project libraries

`org.netbeans.spi.project.libraries.LibraryTypeProvider`

(Aug 31 '07) Customizer for volume type in LibraryTypeProvider is not mandatory

`org.netbeans.spi.project.libraries.NamedLibraryImplementation`

(Jun 16 '11) Allow user created library to provide display name

Details of all changes by API and date

Project Libraries API

Allow user created library to provide display name

Jun 16 '11; API spec. version: 1.31; affected top-level classes: LibraryManager NamedLibraryImplementation; made by: tzezula; issues: #199253
Added displayName property into the Library's SPI allowing an implementor to provide the a display name of the Library which differs from the system (identifying) name.

Added a name of the properties property into LibraryImplementation3

Mar 14 '11; API spec. version: 1.35; affected top-level classes: Library LibraryImplementation3; made by: tzezula
Added the missing LibraryImplementation3.PROP_PROPERTIES providing the name of the properties property.

Allow `Library` to provide properties

Mar 13 '11; API spec. version: 1.34; affected top-level classes: Library LibraryImplementation3; made by: tzezula; issues: #199253
Allow Library to provide properties.

URI used for relative library entries instead of URL

Mar 27 '08; API spec. version: 1.18; affected top-level classes: LibraryManager Library LibrariesCustomizer LibraryCustomizerContext LibraryImplementation2 LibrariesSupport; made by: dkonecny; issues: #129628

API review of Sharable Libraries requested using URI for relative paths instead of URL.

Added LibraryCustomizerContext class to provide richer context to libraries customizer.

Compatibility:

Signatures of some methods previously using URL were changed to use URI. Some URL handling methods were removed and/or replaced with URI counterpart.

Support for project libraries

Jan 22 '08; API spec. version: 1.17; affected top-level classes: LibraryManager Library LibraryChooser LibrariesCustomizer LibraryProvider ArealLibraryProvider LibraryStorageArea LibrariesSupport; made by: jglick; issues: #44035

There is a new API and SPI for project libraries (or, more generally, libraries with specific storage locations). ArealLibraryProvider, and LibraryStorageArea are new, as are methods Library.getManager, Library.getRawContent(String) LibraryManager.getDisplayName, LibraryManager.getLocation, LibraryManager.createLibrary, LibraryManager.forLocation, and LibraryManager.getOpenManagers. (LibraryProvider was also generified.) LibrariesSupport has few additional helper methods.

There's also new methods and classes for UI customizations of Libraries, eg. LibrariesCustomizer.showCreateNewLibraryCustomizer(LibraryManager), LibrariesCustomizer.showCustomizer(Library, LibraryManager), LibrariesCustomizer.showSingleLibraryCustomizer(Library), and LibraryChooser class.

Compatibility:

LibraryManager.addLibrary will not work with areas, so it was deprecated in favor of the new createLibrary.

Code which obtained a Library of arbitrary origin, and then assumed it could refer to that library henceforth by name only, will not work with project libraries. The simplest persistent identifier for a new-style library is pair of name and URL of manager (null for the default manager).

Compatibility:

Clients should begin requesting the new version to avoid a warning at startup.