| <html> |
| <!-- |
| |
| NO NO NO NO NO! |
| |
| ==============> DO NOT EDIT ME! <============== |
| |
| AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT |
| |
| SEE projects/queries/apichanges.xml |
| |
| --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the General Queries API API</title> |
| |
| <link rel="stylesheet" href="prose.css" type="text/css"> |
| |
| </head> |
| |
| <body> |
| |
| |
| <p class="overviewlink"> |
| <a href="overview-summary.html" shape="rect">Overview</a> |
| </p> |
| |
| |
| <h1>Introduction</h1> |
| |
| |
| <p>This document lists changes made to the <a href="../org-netbeans-modules-queries/index.html" shape="rect">General Queries API</a>.</p> |
| |
| <!-- The actual lists of changes, as summaries and details: --> |
| |
| <hr> |
| |
| <h1> |
| <a name="list-all-apis">Index of APIs</a> |
| </h1> |
| <ul> |
| <li> |
| <a href="#general">General Queries API</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>(May 16 '13) <a href="#VersioningQuery">added VersioningQuery</a> |
| </li> |
| <li>(Nov 9 '12) <a href="#VQChangeEvent">VisibilityQueryChangeEvent added</a> |
| </li> |
| <li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li> |
| <li>(Mar 24 '08) <a href="#FileBasedIsVisible">VisibilityQuery.isVisible(File) added</a> |
| </li> |
| <li>(Mar 28 '07) <a href="#FileEncodingQueryOnDefaultFS">Default Encoding of System File System is always UTF-8</a> |
| </li> |
| <li>(Feb 8 '07) <a href="#FileEncodingQuery">Added support for obtaining encoding of files</a> |
| </li> |
| <li>(Jan 14 '05) <a href="#fileinfo-NonRecursiveFolder">Added <code>fileinfo</code> package with <code>NonRecursiveFolder</code> interface.</a> |
| </li> |
| <li>(Dec 22 '04) <a href="#rel-vers-1">Switched to major release version 1</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.queries/1 > 1.20</pre> |
| <ul> |
| <li> |
| (1.35) <a href="#VersioningQuery">added VersioningQuery</a> |
| </li> |
| <li> |
| (1.32) <a href="#VQChangeEvent">VisibilityQueryChangeEvent added</a> |
| </li> |
| <li> |
| (1.27) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li> |
| <li> |
| (1.12) <a href="#FileBasedIsVisible">VisibilityQuery.isVisible(File) added</a> |
| </li> |
| <li> |
| (1.10) <a href="#FileEncodingQueryOnDefaultFS">Default Encoding of System File System is always UTF-8</a> |
| </li> |
| <li> |
| (1.9) <a href="#FileEncodingQuery">Added support for obtaining encoding of files</a> |
| </li> |
| <li> |
| (1.4) <a href="#fileinfo-NonRecursiveFolder">Added <code>fileinfo</code> package with <code>NonRecursiveFolder</code> interface.</a> |
| </li> |
| <li> |
| (1.3) <a href="#rel-vers-1">Switched to major release version 1</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.api.queries.CollocationQuery"><code><span style="color:gray">org.netbeans.api.queries.</span>CollocationQuery</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.CollocationQueryImplementation"><code><span style="color:gray">org.netbeans.spi.queries.</span>CollocationQueryImplementation</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.CollocationQueryImplementation2"><code><span style="color:gray">org.netbeans.spi.queries.</span>CollocationQueryImplementation2</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.queries.FileEncodingQuery"><code><span style="color:gray">org.netbeans.api.queries.</span>FileEncodingQuery</code></a> |
| </h2><ul><li>(Mar 28 '07) <a href="#FileEncodingQueryOnDefaultFS">Default Encoding of System File System is always UTF-8</a> |
| </li> |
| <li>(Feb 8 '07) <a href="#FileEncodingQuery">Added support for obtaining encoding of files</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.FileEncodingQueryImplementation"><code><span style="color:gray">org.netbeans.spi.queries.</span>FileEncodingQueryImplementation</code></a> |
| </h2><ul><li>(Feb 8 '07) <a href="#FileEncodingQuery">Added support for obtaining encoding of files</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.fileinfo.NonRecursiveFolder"><code><span style="color:gray">org.netbeans.api.fileinfo.</span>NonRecursiveFolder</code></a> |
| </h2><ul><li>(Jan 14 '05) <a href="#fileinfo-NonRecursiveFolder">Added <code>fileinfo</code> package with <code>NonRecursiveFolder</code> interface.</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.queries.SharabilityQuery"><code><span style="color:gray">org.netbeans.api.queries.</span>SharabilityQuery</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.SharabilityQueryImplementation"><code><span style="color:gray">org.netbeans.spi.queries.</span>SharabilityQueryImplementation</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.SharabilityQueryImplementation2"><code><span style="color:gray">org.netbeans.spi.queries.</span>SharabilityQueryImplementation2</code></a> |
| </h2><ul><li>(Jan 13 '12) <a href="#SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.queries.VersioningQuery"><code><span style="color:gray">org.netbeans.api.queries.</span>VersioningQuery</code></a> |
| </h2><ul><li>(May 16 '13) <a href="#VersioningQuery">added VersioningQuery</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.VersioningQueryImplementation"><code><span style="color:gray">org.netbeans.spi.queries.</span>VersioningQueryImplementation</code></a> |
| </h2><ul><li>(May 16 '13) <a href="#VersioningQuery">added VersioningQuery</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.queries.VisibilityQuery"><code><span style="color:gray">org.netbeans.api.queries.</span>VisibilityQuery</code></a> |
| </h2><ul><li>(Mar 24 '08) <a href="#FileBasedIsVisible">VisibilityQuery.isVisible(File) added</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.VisibilityQueryChangeEvent"><code><span style="color:gray">org.netbeans.spi.queries.</span>VisibilityQueryChangeEvent</code></a> |
| </h2><ul><li>(Nov 9 '12) <a href="#VQChangeEvent">VisibilityQueryChangeEvent added</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.queries.VisibilityQueryImplementation2"><code><span style="color:gray">org.netbeans.spi.queries.</span>VisibilityQueryImplementation2</code></a> |
| </h2><ul><li>(Mar 24 '08) <a href="#FileBasedIsVisible">VisibilityQuery.isVisible(File) added</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="general">General Queries API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="VersioningQuery">added VersioningQuery</a> |
| </h3> |
| <em>May 16 '13; API spec. version: 1.35; affected top-level classes: <a href="./org/netbeans/spi/queries/VersioningQueryImplementation.html"><code>VersioningQueryImplementation</code></a> <a href="./org/netbeans/api/queries/VersioningQuery.html"><code>VersioningQuery</code></a>; made by: tstupka; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=229281"> |
| #229281</a></em> |
| <br> |
| |
| <p> |
| Added a new query <code>VersioningQuery</code> which provides Versioning relevant info like |
| e.g. if a particular file is managed by a Versioning System. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="VQChangeEvent">VisibilityQueryChangeEvent added</a> |
| </h3> |
| <em>Nov 9 '12; API spec. version: 1.32; affected top-level classes: <a href="./org/netbeans/spi/queries/VisibilityQueryChangeEvent.html"><code>VisibilityQueryChangeEvent</code></a>; made by: mkleint; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=220749"> |
| #220749</a></em> |
| <br> |
| |
| <p> |
| Added new class <code>VisibilityQueryChangeEvent</code> which extends <code>ChangeEvent</code> and can be used by <code>VisibilityQueryImplementation</code> implementors |
| to fire a change event with additional information attached. <code>ChangeListener</code> implementions listening on <code>VisibilityQuery</code> can then check the |
| event's type when it arrives and use the additional information to their advantage. |
| </p> |
| |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="SharabilityQueryBasedOnURI">SharabilityQuery and CollocationQuery extended to use URI</a> |
| </h3> |
| <em>Jan 13 '12; API spec. version: 1.27; affected top-level classes: <a href="./org/netbeans/api/queries/CollocationQuery.html"><code>CollocationQuery</code></a> <a href="./org/netbeans/api/queries/SharabilityQuery.html"><code>SharabilityQuery</code></a> <a href="./org/netbeans/spi/queries/CollocationQueryImplementation.html"><code>CollocationQueryImplementation</code></a> <a href="./org/netbeans/spi/queries/CollocationQueryImplementation2.html"><code>CollocationQueryImplementation2</code></a> <a href="./org/netbeans/spi/queries/SharabilityQueryImplementation.html"><code>SharabilityQueryImplementation</code></a> <a href="./org/netbeans/spi/queries/SharabilityQueryImplementation2.html"><code>SharabilityQueryImplementation2</code></a>; made by: alexvsimon; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=198060"> |
| #198060</a></em> |
| <br> |
| |
| <p> |
| Added new methods CollocationQuery.areCollocated(URI, URI) and CollocationQuery.findRoot(URI). |
| Methods query all CollocationQueryImplementation (if possible) and CollocationQueryImplementation2 instances found in global lookup. |
| Deprecated existing methods CollocationQuery.areCollocated(File, File) and CollocationQuery.findRoot(File). |
| Methods query all CollocationQueryImplementation and CollocationQueryImplementation2 instances found in global lookup. |
| </p> |
| |
| <p> |
| Added new methods SharabilityQuery.getSharability(URI) and SharabilityQuery.getSharability(FileObject). |
| Methods query all SharabilityQueryImplementation (if possible) and SharabilityQueryImplementation2 instances found in global lookup. |
| Deprecated existing method SharabilityQuery.getSharability(File). |
| Method query all SharabilityQueryImplementation and SharabilityQueryImplementation2 instances found in global lookup. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="FileBasedIsVisible">VisibilityQuery.isVisible(File) added</a> |
| </h3> |
| <em>Mar 24 '08; API spec. version: 1.12; affected top-level classes: <a href="./org/netbeans/api/queries/VisibilityQuery.html"><code>VisibilityQuery</code></a> <a href="./org/netbeans/spi/queries/VisibilityQueryImplementation2.html"><code>VisibilityQueryImplementation2</code></a>; made by: mkleint; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=95974"> |
| #95974</a></em> |
| <br> |
| |
| <p> |
| Added new method VisibilityQuery.isVisible(File). |
| It queries all VisibilityQueryImplementation instances found in global lookup. |
| If such instance implements VisibilityQueryImplementation2, it's isVisible(File) method is used directly. |
| If not, it attempts to delegate to the isVisible(FileObject) method. That might not work for non-existing files. |
| All implementations of VisibilityQueryImplementation are encouraged to upgrade to VisibilityQueryImplementation2. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="FileEncodingQueryOnDefaultFS">Default Encoding of System File System is always UTF-8</a> |
| </h3> |
| <em>Mar 28 '07; API spec. version: 1.10; affected top-level classes: <a href="./org/netbeans/api/queries/FileEncodingQuery.html"><code>FileEncodingQuery</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=94676"> |
| #94676</a></em> |
| <br> |
| |
| <p> |
| Whenever someone queries for encoding of a file object on default |
| file system (e.g. the one that is provided by layers), it will get |
| UTF-8 as the default encoding and not the system one. As a result |
| all resources on layers should be in UTF-8 encoding. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="FileEncodingQuery">Added support for obtaining encoding of files</a> |
| </h3> |
| <em>Feb 8 '07; API spec. version: 1.9; affected top-level classes: <a href="./org/netbeans/api/queries/FileEncodingQuery.html"><code>FileEncodingQuery</code></a> <a href="./org/netbeans/spi/queries/FileEncodingQueryImplementation.html"><code>FileEncodingQueryImplementation</code></a>; made by: tzezula; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=42638"> |
| #42638</a></em> |
| <br> |
| |
| <p> |
| Added a query (<code>FileEncodingQuery</code>) to find out the encoding of the file. The query |
| delegates to the instances of the SPI interface (<code>FileEncodingQueryImplementation</code>), |
| when the SPI implementations don't know anything about the file encoding it returns the encoding |
| corresponding to the file.encoding property. The API also provides getter and setter for default |
| project encoding which should be used by the project generator. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="fileinfo-NonRecursiveFolder">Added <code>fileinfo</code> package with <code>NonRecursiveFolder</code> interface.</a> |
| </h3> |
| <em>Jan 14 '05; API spec. version: 1.4; affected top-level classes: <a href="./org/netbeans/api/fileinfo/NonRecursiveFolder.html"><code>NonRecursiveFolder</code></a>; made by: mentlicher; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=52271"> |
| #52271</a></em> |
| <br> |
| |
| <p> |
| |
| <code>fileinfo</code> package introduced for classes providing extra |
| information about files or folders. <code>NonRecursiveFolder</code> interface |
| added. It marks a representation of a folder that have non-recursive |
| content (does not contain subfiles). |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="rel-vers-1">Switched to major release version 1</a> |
| </h3> |
| <em>Dec 22 '04; API spec. version: 1.3; made by: jglick; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=51468"> |
| #51468</a></em> |
| <br> |
| |
| <p> |
| To indicate that this is now considered a stable API, the major release version was |
| incremented to 1 from 0. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| |
| <p> |
| Clients should begin requesting the new version to avoid a warning at startup. |
| </p> |
| |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |
