Change History for the Registry API - NetBeans API Javadoc (Current Development Version)

Introduction

This document lists changes made to the Registry API.

Index of APIs

Registry 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.

(Dec 18 '03) A few compatible and incompatible changes
(Jun 12 '03) SPIUtils.createRootContext(Map) removed
(Jun 5 '03) AttributeEvent.getAttributeName() can return null
(May 23 '03) A few compatible and incompatible changes

All changes by date

(Dec 18 '03) A few compatible and incompatible changes
(Sep 18 '03) Added ability to create merged Contexts
(Jun 12 '03) SPIUtils.createRootContext(Map) removed
(Jun 11 '03) Context.getOrderedNames() added
(Jun 5 '03) AttributeEvent.getAttributeName() can return null
(May 23 '03) A few compatible and incompatible changes

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.registry > 1.20

(1.7) A few compatible and incompatible changes
(1.6) Added ability to create merged Contexts
(1.5) SPIUtils.createRootContext(Map) removed
(1.4) Context.getOrderedNames() added
(1.3) AttributeEvent.getAttributeName() can return null
(1.2) A few compatible and incompatible changes

Changes by affected class

`org.netbeans.spi.registry.BasicContext`

(Dec 18 '03) A few compatible and incompatible changes

`org.netbeans.api.registry.Context`

(Dec 18 '03) A few compatible and incompatible changes
(Sep 18 '03) Added ability to create merged Contexts

`org.netbeans.spi.registry.MergedContextProvider`

(Sep 18 '03) Added ability to create merged Contexts

`org.netbeans.api.registry.ObjectRef`

(Dec 18 '03) A few compatible and incompatible changes

`org.netbeans.spi.registry.RootContext`

(Dec 18 '03) A few compatible and incompatible changes

`org.netbeans.spi.registry.SpiUtils`

(Dec 18 '03) A few compatible and incompatible changes
(Sep 18 '03) Added ability to create merged Contexts

Details of all changes by API and date

Registry API

A few compatible and incompatible changes

Dec 18 '03; API spec. version: 1.7; affected top-level classes: Context ObjectRef org.netbeans.spi.registry.RootContext SpiUtils BasicContext; made by: rmatous; issues: #38109
A few compatible and incompatible changes:

There is waste of time to traverse to root whenever is root necessary. But there is missing convenient getRootContext method (see also getAbsoluteContextName() that returns full path from the root context).

Added method public Context org.netbeans.api.registry.Context.getRootContext()
Added method public BasicContext org.netbeans.spi.registry.BasicContext.getRootContext()

A little confusing constructor for ObjectRef replaced with two constructors.

Removed constructor public org.netbeans.api.registry.ObjectRef(Context rootCtx, Context ctx, String ctxName, String bindingName))
Added constructor public org.netbeans.api.registry.ObjectRef(ContextrootCtx, String ctxName, String bindingName)
Added constructor public org.netbeans.api.registry.ObjectRef(Context ctx, String bindingName)
Removed method public static ObjectRef org.netbeans.spi.registry.SpiUtils.createObjectRef(RootContext rootCtx, BasicContext ctx, String contextName, String bindingName)
Added method public static ObjectRef org.netbeans.spi.registry.SpiUtils.createObjectRef (BasicContext rootCtx, String ctxName, String bindingName)
Added method public static ObjectRef org.netbeans.spi.registry.SpiUtils.createObjectRef (BasicContext ctx, String bindingName)

In RootContext are all 3 methods optional and can throw UnsupportedOperationException. Method flush was never implemented and method getMutex won't be necessary beacuse just one Mutext will be shared for all Contexts. Method findObject could be used for backward compatibility replacing current autosave functionality but its not vital and can be ommited. So I suggest to remove RootContex from API.

Removed interface org.netbeans.spi.registry.RootContext
Removed method public ObjectRef org.netbeans.api.registry.Context.findObject(Object obj)

Added ability to create merged Contexts

Sep 18 '03; API spec. version: 1.6; affected top-level classes: Context SpiUtils MergedContextProvider; made by: rmatous; issues: #34057
Following API changes was made to provide ability to create merged Contexts:

added method org.netbeans.api.registry.Context.merge(Context[]), which returns implementation of org.netbeans.api.registry.Context
added method org.netbeans.spi.registry.SpiUtils.merge(MergedContextProvider), which returns implementation of org.netbeans.spi.registry.BasicContext
added interface org.netbeans.spi.registry.MergedContextProvider, which provides delegates for merged context and notifies about changes.

Subcontext, bindings and attributes for context are merged according their names overtaken from their delegates.

SPIUtils.createRootContext(Map) removed

Jun 12 '03; API spec. version: 1.5; made by: dkonecny; issues: #34342
SPIUtils.createRootContext(Map) method will be removed. Use method org.netbeans.api.registry.fs.FileSystemContextFactory.createContext(FileObject) from core/registry module instead. It is possible that this method is already in use and so it was left in the API for week or two with warning message. Remove its usage immediatelly because it will be removed very soon, definitely before release.

The Context.getObjects method was removed. It was not implemented and so nobody should be using it. The Context.getOrderedObjects should be used instead.
ContextFactory.getRootContext method was deprecated and will be removed. Use Context.getDefault() method instead. It is possible that this method is already in use and so it was left in the API for week or two with warning message. Remove its usage immediatelly because it will be removed very soon, definitely before release.
ContextAdaptor convenient class was added.