blob: 6ba875daa97a8882fe94173ebb603ad8d4d5cea4 [file] [log] [blame]
<html>
<!--
NO NO NO NO NO!
==============> DO NOT EDIT ME! <======================
AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT
SEE core/settings/api/doc/changes/apichanges.xml
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Settings API/SPI Changes by Date</title>
<link rel="stylesheet" href="prose.css" type="text/css">
</head>
<body>
<!-- The actual lists of changes, as summaries and details: -->
<p class="overviewlink">
<a href="overview-summary.html" shape="rect">Overview</a>
</p>
<h1>
<a name="list-all-apis">Index of APIs</a>
</h1>
<ul>
<li>
<a href="#settings_api">Settings API</a>
</li>
<li>
<a href="#settings_spi">Settings SPI</a>
</li>
</ul>
<h1>
<a name="incompat-by-date">Incompatible changes by date</a>
</h1>
<p>Fuller descriptions of all changes can be found below (follow links).</p>
<p>Not all deprecations are listed here, assuming that the deprecated
APIs continue to essentially work. For a full deprecation list, please
consult the
<a href="deprecated-list.html">Javadoc</a>.</p>
<ul></ul>
<h1>
<a name="all-by-date">All changes by date</a>
</h1>
<ul>
<li>(Mar 15 '13) <a href="#method.factory">Instances may have factory methods</a>
</li>
<li>(Nov 30 '10) <a href="#private.factories">Factory methods can be private</a>
</li>
<li>(Aug 7 '09) <a href="#convert.as.javabean">@ConvertAsJavaBean annotation</a>
</li>
<li>(Jan 10 '09) <a href="#readResolveBehaviour">readProperties can designate its replace</a>
</li>
<li>(Jan 10 '09) <a href="#convertor.propertyannotation">@ConvertAsProperties annotation</a>
</li>
<li>(Nov 28 '08) <a href="#convertor.recognize.xml">Allow convertors to recognize .xml files in specially attributed folders.</a>
</li>
<li>(Jul 22 '08) <a href="#ignore.removed.classes">Ignore settings for intentionally removed classes.</a>
</li>
<li>(Apr 17 '07) <a href="#support.Lookups.forPath">Provides support for <code>Lookups.forPath</code></a>
</li>
<li>(May 9 '06) <a href="#settings.subclasses">Added new attribute for provider registration - settings.subclasses</a>
</li>
<li>(Sep 3 '02) <a href="#issue-26076">Provide context to convertors</a>
</li>
<li>(Aug 22 '02) <a href="#issue-26284">Added DOMConvertor supporting composed content</a>
</li>
</ul>
<h1>
<a name="all-by-version">Changes by version</a>
</h1>
<p>
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 <samp>1.20</samp>, your
manifest should contain in its main attributes the line:
</p>
<pre>OpenIDE-Module-Module-Dependencies: org.netbeans.modules.settings/1 &gt; 1.20</pre>
<ul>
<li>
(1.40) <a href="#method.factory">Instances may have factory methods</a>
</li>
<li>
(1.29) <a href="#private.factories">Factory methods can be private</a>
</li>
<li>
(1.20) <a href="#convert.as.javabean">@ConvertAsJavaBean annotation</a>
</li>
<li>
(1.18) <a href="#readResolveBehaviour">readProperties can designate its replace</a>
</li>
<li>
(1.18) <a href="#convertor.propertyannotation">@ConvertAsProperties annotation</a>
</li>
<li>
(1.17) <a href="#convertor.recognize.xml">Allow convertors to recognize .xml files in specially attributed folders.</a>
</li>
<li>
(1.13) <a href="#ignore.removed.classes">Ignore settings for intentionally removed classes.</a>
</li>
<li>
(1.13) <a href="#support.Lookups.forPath">Provides support for <code>Lookups.forPath</code></a>
</li>
<li>
(1.12) <a href="#settings.subclasses">Added new attribute for provider registration - settings.subclasses</a>
</li>
<li>
(1.2) <a href="#issue-26076">Provide context to convertors</a>
</li>
<li>
(1.1) <a href="#issue-26284">Added DOMConvertor supporting composed content</a>
</li>
</ul>
<h1>
<a name="all-by-class">Changes by affected class</a>
</h1>
<h2>
<a name="org.netbeans.api.settings.ConvertAsJavaBean"><code><span style="color:gray">org.netbeans.api.settings.</span>ConvertAsJavaBean</code></a>
</h2><ul><li>(Aug 7 '09) <a href="#convert.as.javabean">@ConvertAsJavaBean annotation</a>
</li></ul><h2>
<a name="org.netbeans.api.settings.ConvertAsProperties"><code><span style="color:gray">org.netbeans.api.settings.</span>ConvertAsProperties</code></a>
</h2><ul><li>(Jan 10 '09) <a href="#convertor.propertyannotation">@ConvertAsProperties annotation</a>
</li></ul><h2>
<a name="org.netbeans.spi.settings.Convertor"><code><span style="color:gray">org.netbeans.spi.settings.</span>Convertor</code></a>
</h2><ul><li>(Sep 3 '02) <a href="#issue-26076">Provide context to convertors</a>
</li></ul><h2>
<a name="org.netbeans.spi.settings.DOMConvertor"><code><span style="color:gray">org.netbeans.spi.settings.</span>DOMConvertor</code></a>
</h2><ul><li>(Sep 3 '02) <a href="#issue-26076">Provide context to convertors</a>
</li>
<li>(Aug 22 '02) <a href="#issue-26284">Added DOMConvertor supporting composed content</a>
</li></ul><h2>
<a name="org.netbeans.api.settings.FactoryMethod"><code><span style="color:gray">org.netbeans.api.settings.</span>FactoryMethod</code></a>
</h2><ul><li>(Mar 15 '13) <a href="#method.factory">Instances may have factory methods</a>
</li></ul><hr>
<h1>
<a name="details-by-api">Details of all changes by API and date</a>
</h1>
<hr style="width:50%">
<h2>
<a name="settings_api">Settings API</a>
</h2>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="method.factory">Instances may have factory methods</a>
</h3>
<em>Mar 15 '13; API spec. version: 1.40; affected top-level classes: <a href="./org/netbeans/api/settings/FactoryMethod.html"><code>FactoryMethod</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=227050">
#227050</a></em>
<br>
No need for the instances to have default constructor anymore.
One can tell the system to use different factory method.
<hr style="width:50%">
<h2>
<a name="settings_spi">Settings SPI</a>
</h2>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="private.factories">Factory methods can be private</a>
</h3>
<em>Nov 30 '10; API spec. version: 1.29; made by: jtulach</em>
<br>
To be consistent with behavior of methodvalue attribute of
<a href="../org-openide-filesystems/org/openide/filesystems/XMLFileSystem.html" shape="rect">XMLFileSystem</a>,
now the factory methods referenced from settings files can be <code> private static</code>
as well.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="convert.as.javabean">@ConvertAsJavaBean annotation</a>
</h3>
<em>Aug 7 '09; API spec. version: 1.20; affected top-level classes: <a href="./org/netbeans/api/settings/ConvertAsJavaBean.html"><code>ConvertAsJavaBean</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=169620">
#169620</a></em>
<br>
Easy way to use JavaBean's archiver for persistence of objects.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="readResolveBehaviour">readProperties can designate its replace</a>
</h3>
<em>Jan 10 '09; API spec. version: 1.18; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=155962">
#155962</a></em>
<br>
Semantics of <code>readProperties</code> method has been extended
to allow the method to return an object. Read
<a href="org/netbeans/spi/settings/package-summary.html#xmlprops" shape="rect">more</a>.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="convertor.propertyannotation">@ConvertAsProperties annotation</a>
</h3>
<em>Jan 10 '09; API spec. version: 1.18; affected top-level classes: <a href="./org/netbeans/api/settings/ConvertAsProperties.html"><code>ConvertAsProperties</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=155962">
#155962</a></em>
<br>
Human friendly way to register XML property based convertor via
the <code>@ConvertAsProperties</code> annotation.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="convertor.recognize.xml">Allow convertors to recognize .xml files in specially attributed folders.</a>
</h3>
<em>Nov 28 '08; API spec. version: 1.17; made by: saubrecht; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=154028">
#154028</a></em>
<br>
If a folder in SFS has attribute <code>recognizeXML=true</code> then
Convertors will attempt to process also files with .xml extension.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="ignore.removed.classes">Ignore settings for intentionally removed classes.</a>
</h3>
<em>Jul 22 '08; API spec. version: 1.13; made by: jskrivanek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=137240">
#137240</a></em>
<br>
To prevent ClassNotFoundException while loading *.settings where
intentionally removed class is either in &lt;instance class="..."/&gt;
or &lt;serialdata class="..."&gt; it is possible to declare such
class in <code>META-INF/netbeans/translate.names</code>. If class name
maps to empty string, it is ignored. E.g.:<br>
<br>
<code>org.mypackage.OldClass=</code>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="support.Lookups.forPath">Provides support for <code>Lookups.forPath</code></a>
</h3>
<em>Apr 17 '07; API spec. version: 1.13; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=98426">
#98426</a></em>
<br>
Provides support for <a href="../org-openide-util-lookup/org/openide/util/lookup/Lookups.html#forPath-java.lang.String-" shape="rect">Lookups.forPath(String)</a>
method in order to replace now deprecated <a href="../org-openide-loaders/org/openide/loaders/FolderLookup.html" shape="rect">FolderLookup</a>.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="settings.subclasses">Added new attribute for provider registration - settings.subclasses</a>
</h3>
<em>May 9 '06; API spec. version: 1.12; made by: dstrupl; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=65950">
#65950</a></em>
<br> 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.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="issue-26076">Provide context to convertors</a>
</h3>
<em>Sep 3 '02; API spec. version: 1.2; affected top-level classes: <a href="./org/netbeans/spi/settings/Convertor.html"><code>Convertor</code></a> <a href="./org/netbeans/spi/settings/DOMConvertor.html"><code>DOMConvertor</code></a>; made by: jpokorsky; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=26076">
#26076</a></em>
<br> Get a context associated with the reader.
It can contain various info like a file location of the read object etc.
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3>
<a name="issue-26284">Added DOMConvertor supporting composed content</a>
</h3>
<em>Aug 22 '02; API spec. version: 1.1; affected top-level classes: <a href="./org/netbeans/spi/settings/DOMConvertor.html"><code>DOMConvertor</code></a>; made by: jpokorsky; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=26284">
#26284</a></em>
<br> Allow to reuse already written convertors
by newly created ones to facilitate a storing of complex objects.
<hr>
<p><span class="footnote">Built on September 14 2018.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p>
</body>
</html>