| <html> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the Java Hints SPI</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 Java Hints SPI.</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="#JavaHintsSPI">Java Hints 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>(Jan 15 '18) <a href="#JavaFixUtilities.isPrimary">Added JavaFixUtilities.isPrimary() utility</a> |
| </li> |
| <li>(Jul 27 '15) <a href="#TriggerOptions">Hint can choose to trigger for guarded code</a> |
| </li> |
| <li>(May 24 '15) <a href="#Hint.minSourceVersion">Hint can specify minimum source version for operation</a> |
| </li> |
| <li>(Jul 14 '13) <a href="#EnhancedJavaFix">Added ability to specify sort text for JavaFix</a> |
| </li> |
| <li>(Apr 24 '13) <a href="#ProjectHintsJava">Defining system filesystem folder for per-project Java hints customizers</a> |
| </li> |
| <li>(Apr 3 '13) <a href="#IntegerOption">Added support for integer options. Hints can be declared to appear only in inspect & transform</a> |
| </li> |
| <li>(Dec 19 '12) <a href="#ErrorDescriptionFactory.forSpan">Introducing ErrorDescriptionFactory.forSpan.</a> |
| </li> |
| <li>(Mar 29 '12) <a href="#TransformationSupport">Added support for using jackpot patterns from other modules (e.g. refactoring).</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: $codebase > 1.20</pre> |
| <ul> |
| <li> |
| (1.31) <a href="#JavaFixUtilities.isPrimary">Added JavaFixUtilities.isPrimary() utility</a> |
| </li> |
| <li> |
| (1.28) <a href="#Hint.minSourceVersion">Hint can specify minimum source version for operation</a> |
| </li> |
| <li> |
| (1.27) <a href="#TriggerOptions">Hint can choose to trigger for guarded code</a> |
| </li> |
| <li> |
| (1.18) <a href="#EnhancedJavaFix">Added ability to specify sort text for JavaFix</a> |
| </li> |
| <li> |
| (1.16) <a href="#ProjectHintsJava">Defining system filesystem folder for per-project Java hints customizers</a> |
| </li> |
| <li> |
| (1.14) <a href="#IntegerOption">Added support for integer options. Hints can be declared to appear only in inspect & transform</a> |
| </li> |
| <li> |
| (1.9) <a href="#ErrorDescriptionFactory.forSpan">Introducing ErrorDescriptionFactory.forSpan.</a> |
| </li> |
| <li> |
| (1.1) <a href="#TransformationSupport">Added support for using jackpot patterns from other modules (e.g. refactoring).</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.spi.java.hints.ErrorDescriptionFactory"><code><span style="color:gray">org.netbeans.spi.java.hints.</span>ErrorDescriptionFactory</code></a> |
| </h2><ul><li>(Dec 19 '12) <a href="#ErrorDescriptionFactory.forSpan">Introducing ErrorDescriptionFactory.forSpan.</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.java.hints.Hint"><code><span style="color:gray">org.netbeans.spi.java.hints.</span>Hint</code></a> |
| </h2><ul><li>(Apr 3 '13) <a href="#IntegerOption">Added support for integer options. Hints can be declared to appear only in inspect & transform</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.java.hints.IntegerOption"><code><span style="color:gray">org.netbeans.spi.java.hints.</span>IntegerOption</code></a> |
| </h2><ul><li>(Apr 3 '13) <a href="#IntegerOption">Added support for integer options. Hints can be declared to appear only in inspect & transform</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.java.hints.support.TransformationSupport"><code><span style="color:gray">org.netbeans.spi.java.hints.support.</span>TransformationSupport</code></a> |
| </h2><ul><li>(Mar 29 '12) <a href="#TransformationSupport">Added support for using jackpot patterns from other modules (e.g. refactoring).</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="JavaHintsSPI">Java Hints SPI</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="JavaFixUtilities.isPrimary">Added JavaFixUtilities.isPrimary() utility</a> |
| </h3> |
| <em>Jan 15 '18; API spec. version: 1.31</em> |
| <br> |
| |
| <p> |
| The utility method JavaFixUtilities.isPrimary() was added. |
| This API checks whether a specified tree can be used in |
| places where a Primary expression is required. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="TriggerOptions">Hint can choose to trigger for guarded code</a> |
| </h3> |
| <em>Jul 27 '15; API spec. version: 1.27; made by: sdedic</em> |
| <br> |
| |
| <p> |
| Hints triggered by Tree.Kind are not invoked for Trees which are |
| protected from editing (i.e. Form Builder guarded blocks). Hint implementor |
| can opt to be triggered even for such code, in order to e.g. collect |
| data. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="Hint.minSourceVersion">Hint can specify minimum source version for operation</a> |
| </h3> |
| <em>May 24 '15; API spec. version: 1.28; made by: sdedic</em> |
| <br> |
| |
| <p> |
| Certain hints generate source code following newer language specifications. |
| A hint may declare <code>minSourceVersion</code> in its <code>@Hint</code> |
| annotation to specify a minimum source version. Such hint will be never |
| invoked for files configured for earlier source level. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="EnhancedJavaFix">Added ability to specify sort text for JavaFix</a> |
| </h3> |
| <em>Jul 14 '13; API spec. version: 1.18; made by: jlahoda</em> |
| <br> |
| |
| <p> |
| Adding to new constructors to <code>JavaFix</code> to define |
| the sort text for the fix. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="ProjectHintsJava">Defining system filesystem folder for per-project Java hints customizers</a> |
| </h3> |
| <em>Apr 24 '13; API spec. version: 1.16; made by: jlahoda</em> |
| <br> |
| |
| <p> |
| Defining <code>Project/hints/java-based</code> folder, where provider for |
| hints customizers for Java-based projects should be stored. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="IntegerOption">Added support for integer options. Hints can be declared to appear only in inspect & transform</a> |
| </h3> |
| <em>Apr 3 '13; API spec. version: 1.14; affected top-level classes: <a href="./org/netbeans/spi/java/hints/IntegerOption.html"><code>IntegerOption</code></a> <a href="./org/netbeans/spi/java/hints/Hint.html"><code>Hint</code></a>; made by: sdedic; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=227822"> |
| #227822</a> <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=227959"> |
| #227959</a></em> |
| <br> |
| |
| <p> |
| Added declarative support for integer options. <code>@IntegerOption</code> can |
| be used with option name field, similar to <code>@BooleanOption</code>. |
| </p> |
| |
| <p> |
| An option was added to <code>Hint.Options</code>, so that hint can declare |
| to be only shown in Inspect & transform dialog. Useful for computation-intensive |
| hints, which should only run on demand. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="ErrorDescriptionFactory.forSpan">Introducing ErrorDescriptionFactory.forSpan.</a> |
| </h3> |
| <em>Dec 19 '12; API spec. version: 1.9; affected top-level classes: <a href="./org/netbeans/spi/java/hints/ErrorDescriptionFactory.html"><code>ErrorDescriptionFactory</code></a>; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=223723"> |
| #223723</a></em> |
| <br> |
| |
| <p> |
| Added ErrorDescriptionFactory.forSpan to create the correct |
| Java-enhanced ErrorDescription from a span. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="TransformationSupport">Added support for using jackpot patterns from other modules (e.g. refactoring).</a> |
| </h3> |
| <em>Mar 29 '12; API spec. version: 1.1; affected top-level classes: <a href="./org/netbeans/spi/java/hints/support/TransformationSupport.html"><code>TransformationSupport</code></a>; made by: jbecicka; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=210262"> |
| #210262</a></em> |
| <br> |
| |
| <p> |
| Added support for using jackpot patterns from other modules (e.g. refactoring). |
| </p> |
| |
| |
| |
| <hr> |
| |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| </body> |
| |
| </html> |
