Index of APIs

Settings SPI

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

(Aug 7 '09) @ConvertAsJavaBean annotation
(Jan 10 '09) readProperties can designate its replace
(Jan 10 '09) @ConvertAsProperties annotation
(Nov 28 '08) Allow convertors to recognize .xml files in specially attributed folders.
(Jul 22 '08) Ignore settings for intentionally removed classes.
(Apr 17 '07) Provides support for Lookups.forPath
(May 9 '06) Added new attribute for provider registration - settings.subclasses
(Sep 3 '02) Provide context to convertors
(Aug 22 '02) Added DOMConvertor supporting composed content

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

(1.20) @ConvertAsJavaBean annotation
(1.18) readProperties can designate its replace
(1.18) @ConvertAsProperties annotation
(1.17) Allow convertors to recognize .xml files in specially attributed folders.
(1.13) Ignore settings for intentionally removed classes.
(1.13) Provides support for Lookups.forPath
(1.12) Added new attribute for provider registration - settings.subclasses
(1.2) Provide context to convertors
(1.1) Added DOMConvertor supporting composed content

Changes by affected class

`org.netbeans.api.settings.ConvertAsJavaBean`

(Aug 7 '09) @ConvertAsJavaBean annotation

`org.netbeans.api.settings.ConvertAsProperties`

(Jan 10 '09) @ConvertAsProperties annotation

`org.netbeans.spi.settings.Convertor`

(Sep 3 '02) Provide context to convertors

`org.netbeans.spi.settings.DOMConvertor`

(Sep 3 '02) Provide context to convertors
(Aug 22 '02) Added DOMConvertor supporting composed content

Details of all changes by API and date

Settings SPI

@ConvertAsJavaBean annotation

Aug 7 '09; API spec. version: 1.20; affected top-level classes: ConvertAsJavaBean; made by: jtulach; issues: #169620
Easy way to use JavaBean's archiver for persistence of objects.

readProperties can designate its replace

Jan 10 '09; API spec. version: 1.18; made by: jtulach; issues: #155962
Semantics of readProperties method has been extended to allow the method to return an object. Read more.

@ConvertAsProperties annotation

Jan 10 '09; API spec. version: 1.18; affected top-level classes: ConvertAsProperties; made by: jtulach; issues: #155962
Human friendly way to register XML property based convertor via the @ConvertAsProperties annotation.

Allow convertors to recognize .xml files in specially attributed folders.

Nov 28 '08; API spec. version: 1.17; made by: saubrecht; issues: #154028
If a folder in SFS has attribute recognizeXML=true then Convertors will attempt to process also files with .xml extension.

Ignore settings for intentionally removed classes.

Jul 22 '08; API spec. version: 1.13; made by: jskrivanek; issues: #137240
To prevent ClassNotFoundException while loading *.settings where intentionally removed class is either in <instance class="..."/> or <serialdata class="..."> it is possible to declare such class in META-INF/netbeans/translate.names. If class name maps to empty string, it is ignored. E.g.:

org.mypackage.OldClass=

Provides support for `Lookups.forPath`

Apr 17 '07; API spec. version: 1.13; made by: jtulach; issues: #98426
Provides support for Lookups.forPath(String) method in order to replace now deprecated FolderLookup.

Added new attribute for provider registration - settings.subclasses

May 9 '06; API spec. version: 1.12; made by: dstrupl; issues: #65950
New file attribute can be used if the registered convertor is capable of handling subclasses of the registered class. The attribute name is "settings.subclasses" and it can be set on the same file object under "xml/memory" as "settings.providerPath". The value of the attribute must be boolean. Defaults to false.

Provide context to convertors

Sep 3 '02; API spec. version: 1.2; affected top-level classes: Convertor DOMConvertor; made by: jpokorsky; issues: #26076
Get a context associated with the reader. It can contain various info like a file location of the read object etc.

Added DOMConvertor supporting composed content

Aug 22 '02; API spec. version: 1.1; affected top-level classes: DOMConvertor; made by: jpokorsky; issues: #26284
Allow to reuse already written convertors by newly created ones to facilitate a storing of complex objects.