| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181) on Fri Sep 14 11:38:53 BST 2018 --> |
| <title>Overview (Java Source)</title> |
| <meta name="date" content="2018-09-14"> |
| <link rel="stylesheet" type="text/css" href="javadoc.css" title="Style"> |
| <script type="text/javascript" src="script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Overview (Java Source)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li class="navBarCell1Rev">Overview</li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li><a href="index-files/index-1.html">Index</a></li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">org.netbeans.modules.java.source 0.166.1 32</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?overview-summary.html" target="_top">Frames</a></li> |
| <li><a href="overview-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 class="title">Java Source<br/><span style='font-style:normal; font-size:medium; font-weight:normal; background-color:#e0a0a0;'><a href='http://wiki.netbeans.org/API_Stability#Friend' target='_blank'>Friend, Private or Third Party</a></span></h1> |
| </div> |
| <div class="header"> |
| <p>See: <a href="#overview.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Java Source table, listing packages, and an explanation"> |
| <caption><span>Java Source</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/netbeans/api/java/loaders/package-summary.html">org.netbeans.api.java.loaders</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/netbeans/api/java/source/package-summary.html">org.netbeans.api.java.source</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/netbeans/api/java/source/support/package-summary.html">org.netbeans.api.java.source.support</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/netbeans/spi/java/loaders/package-summary.html">org.netbeans.spi.java.loaders</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="contentContainer"><a name="overview.description"> |
| <!-- --> |
| </a> |
| <div class="block"><p> |
| |
| <p> |
| Provides Java Model API access. |
| ensure.built.source.roots |
| When the <code>ensure.built.source.roots</code> property is set during ant script execution, |
| the <code>javac</code> task will not actually build the classfiles from scratch, but rather copy classfiles |
| produced by the Java infrastructure into the output folder. The content of the property will |
| be interpreted as list of source roots, for which the artifacts should be copied. |
| |
| </p> |
| |
| </p> |
| <h3>What is New (see <a href="apichanges.html">all changes</a>)?</h3> |
| <ul> |
| |
| |
| <!--Search for dates that are later or equal to 1997-09-01 in |
| .--> |
| <!--Checking date 2014-7-15 with count of newer 0--><!--year ok--> |
| <li>Jul 15 '14 <a href="apichanges.html#RemoteJavadocPolicy">Added a possibility to specify remote javadoc handling policy</a> |
| <p> |
| Added a possibility to specify remote javadoc handling policy in <code>JavadocHelper</code> |
| |
| </p> |
| </li> |
| <!--Checking date 2014-7-10 with count of newer 1--><!--year ok--> |
| <li>Jul 10 '14 <a href="apichanges.html#nodeReplacemenHints">Added API to preserve comments and whitespaces in transformations</a> |
| <p> |
| If a transformation moves a Tree node elsewhere, or produces a replacement of it, it can now mark the new tree as a 'replacement' for the old one, |
| which causes whitespaces (most notably comments) to attach to the replacement node. |
| </p> |
| </li> |
| <!--Checking date 2014-4-30 with count of newer 2--><!--year ok--> |
| <li>Apr 30 '14 <a href="apichanges.html#server.is.free">Desktop independent parts of the Java Source module extracted</a> |
| <p> |
| |
| <p> |
| Runtime compatibility remains, compile time compatibility is |
| mostly preserved too. It is however recommended to upgrade |
| dependencies of client modules. Try running |
| <code>ant fix-dependencies</code> in your Ant module. |
| </p> |
| |
| </p> |
| </li> |
| <!--Checking date 2014-4-14 with count of newer 3--><!--year ok--> |
| <li>Apr 14 '14 <a href="apichanges.html#newUtilityMethods">Added couple of new utility methods to TreeUtilities, ElementUtilities, and SourceUtils.</a> |
| <p> |
| Added new utility methods getPathElementOfKind and getUninitializedFields to TreeUtilities. |
| Added new utility methods getElementName, findOverridableMethods, hasGetter and hasSetter to ElementUtilities. |
| Added new utility methods resolveCapturedType and getForwardReferences to SourceUtils. |
| </p> |
| </li> |
| <!--Checking date 2013-11-19 with count of newer 4--><!--year ok--> |
| <li>Nov 19 '13 <a href="apichanges.html#findLabelSpan">Added utility methods to find span of a Label's name in the source.</a> |
| <p> |
| Added utility methods to find span of a Label's name in the source. |
| Returns starting and ending offset of the label's name in the source code that was parsed |
| (ie. CompilationInfo.getText()), which may differ from the positions in the source |
| document if it has been already altered. |
| </p> |
| </li> |
| <!--Checking date 2013-8-20 with count of newer 5--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-5-27 with count of newer 6--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-5-16 with count of newer 7--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-5-3 with count of newer 8--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-4-30 with count of newer 9--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-4-12 with count of newer 10--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-3-22 with count of newer 11--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-2-28 with count of newer 12--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2013-2-13 with count of newer 13--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-12-31 with count of newer 14--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-4-11 with count of newer 15--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-4-5 with count of newer 16--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-3-13 with count of newer 17--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-3-13 with count of newer 17--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-3-13 with count of newer 17--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-2-21 with count of newer 20--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-1-26 with count of newer 21--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2012-1-26 with count of newer 21--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-11-30 with count of newer 23--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-11-7 with count of newer 24--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-10-26 with count of newer 25--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-10-20 with count of newer 26--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-8-29 with count of newer 27--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-8-26 with count of newer 28--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-8-1 with count of newer 29--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-7-13 with count of newer 30--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-6-22 with count of newer 31--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-6-1 with count of newer 32--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-4-26 with count of newer 33--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2011-1-21 with count of newer 34--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-12-10 with count of newer 35--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-11-12 with count of newer 36--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-10-12 with count of newer 37--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-9-27 with count of newer 38--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-9-16 with count of newer 39--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-9-8 with count of newer 40--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-7-13 with count of newer 41--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-3-2 with count of newer 42--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2010-2-24 with count of newer 43--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-10-27 with count of newer 44--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-8-14 with count of newer 45--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-8-12 with count of newer 46--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-8-6 with count of newer 47--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-5-7 with count of newer 48--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2009-3-31 with count of newer 49--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-11-24 with count of newer 50--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-8-13 with count of newer 51--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-7-7 with count of newer 52--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-6-25 with count of newer 53--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-5-6 with count of newer 54--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-3-25 with count of newer 55--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-3-15 with count of newer 56--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2008-1-25 with count of newer 57--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-12-21 with count of newer 58--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-12-14 with count of newer 59--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-11-26 with count of newer 60--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-15 with count of newer 61--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-15 with count of newer 61--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-15 with count of newer 61--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-15 with count of newer 61--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-13 with count of newer 65--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-6-5 with count of newer 66--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-4-24 with count of newer 67--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-4-19 with count of newer 68--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-4-13 with count of newer 69--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-4-4 with count of newer 70--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-3-26 with count of newer 71--><!--Skipped as the amount of changes is too big--> |
| <!--Checking date 2007-3-18 with count of newer 72--><!--Skipped as the amount of changes is too big--> |
| </ul> |
| <h3>Use Cases</h3> |
| <answer id="arch-usecases"> |
| |
| <p> |
| XXX no answer for arch-usecases |
| </p> |
| |
| </answer> |
| <h3>Exported Interfaces</h3> |
| |
| This table lists all of the module exported APIs |
| with |
| defined stability classifications. It is generated |
| based on answers to questions about the architecture |
| of the module. <a href="architecture-summary.html">Read them all</a>... |
| |
| |
| <a name="group-systemproperty"> |
| <h5>Group of systemproperty interfaces</h5> |
| </a> |
| <table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%"> |
| <tr> |
| <td> |
| <table border="0" cellpadding="3" cellspacing="1" width="100%"> |
| <tr class="tablersh"> |
| <td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td> |
| </tr> |
| <tr class="tabler"> |
| <td>ensure.built.source.roots</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="systemproperty-ensure.built.source.roots"> |
| <p></p> |
| When the <code>ensure.built.source.roots</code> property is set during ant script execution, |
| the <code>javac</code> task will not actually build the classfiles from scratch, but rather copy classfiles |
| produced by the Java infrastructure into the output folder. The content of the property will |
| be interpreted as list of source roots, for which the artifacts should be copied. |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-java"> |
| <h5>Group of java interfaces</h5> |
| </a> |
| <table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%"> |
| <tr> |
| <td> |
| <table border="0" cellpadding="3" cellspacing="1" width="100%"> |
| <tr class="tablersh"> |
| <td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-lookup"> |
| <h5>Group of lookup interfaces</h5> |
| </a> |
| <table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%"> |
| <tr> |
| <td> |
| <table border="0" cellpadding="3" cellspacing="1" width="100%"> |
| <tr class="tablersh"> |
| <td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td> |
| </tr> |
| <tr class="tabler"> |
| <td>org.openide.loaders.CreateFromTemplateAttributesProvider</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="lookup-org.openide.loaders.CreateFromTemplateAttributesProvider"> |
| <p></p> |
| Attributes provider is registered in <code>META-INF/services</code>. It provides |
| <code>package</code>, <code>javaSourceLevel</code> and <code>java15style</code> attributes for java templates using scripting support. |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-property"> |
| <h5>Group of property interfaces</h5> |
| </a> |
| <table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%"> |
| <tr> |
| <td> |
| <table border="0" cellpadding="3" cellspacing="1" width="100%"> |
| <tr class="tablersh"> |
| <td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td> |
| </tr> |
| <tr class="tabler"> |
| <td>package</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="property-package"> |
| <p></p> |
| |
| <code>package</code> attribute contains java package as <code>String</code> for newly created |
| templates using scripting. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>javaSourceLevel</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="property-javaSourceLevel"> |
| <p></p> |
| |
| <code>javaSourceLevel</code> attribute contains java source level as <code>String</code> (e.g. "1.5") for newly created |
| templates using scripting. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>java15style</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="property-java15style"> |
| <p></p> |
| |
| <code>java15style</code> attribute is defined for newly created |
| templates using scripting only if java source level is 1.5 or later. |
| Useful to conditionally generate code with java 1.5 features (generics, annotations, etc.). |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <h3>Implementation Details</h3> |
| <h5>Where are the sources for the module?</h5> |
| |
| <p> |
| <p> |
| The sources for the module are in the |
| <a href="http://hg.netbeans.org/" shape="rect">NetBeans Mercurial repositories</a>. |
| </p> |
| </p> |
| |
| <h5>What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?</h5> |
| |
| <p> |
| XXX no answer for deploy-dependencies |
| </p> |
| |
| <p> |
| Read more about the implementation in the <a href="architecture-summary.html">answers to |
| architecture questions</a>. |
| </p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li class="navBarCell1Rev">Overview</li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li><a href="index-files/index-1.html">Index</a></li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">org.netbeans.modules.java.source 0.166.1 32</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?overview-summary.html" target="_top">Frames</a></li> |
| <li><a href="overview-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></small></p> |
| </body> |
| </html> |
