blob: 5aaf0813906fc3b0c82ed95775e9cc1e67c83ba9 [file] [log] [blame]
<!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:39:22 BST 2018 -->
<title>Overview (Java SE Projects)</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 SE Projects)";
}
}
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><a href="org/netbeans/modules/java/j2seproject/api/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/netbeans/modules/java/j2seproject/api/package-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.j2seproject/1 1.89.1 48</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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;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 SE Projects<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 SE Projects table, listing packages, and an explanation">
<caption><span>Java SE Projects</span><span class="tabEnd">&nbsp;</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/modules/java/j2seproject/api/package-summary.html">org.netbeans.modules.java.j2seproject.api</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer"><a name="overview.description">
<!-- -->
</a>
<div class="block"><p>
<p>
Uses various project APIs to implement the project type. <a href="http://projects.netbeans.org/buildsys/design.html" shape="rect">Build system design
document</a>
</p>
<ol>
<li>
<a href="http://www.netbeans.org/ns/j2se-project/1.xsd">j2se-project.xsd</a>
<p>
Definition of j2seproject-specific portions of <code>project.xml</code> (1st revision).
</p>
</li>
<li>
<a href="http://www.netbeans.org/ns/j2se-project/2.xsd">j2se-project-2.xsd</a>
<p>
Definition of j2seproject-specific portions of <code>project.xml</code> (2nd revision).
</p>
</li>
<li>
project.properties
<p>
Definition of recognized keys in <code>project.properties</code> and/or
<code>private.properties</code>. XXX not yet formally specified.
</p>
</li>
<li>
build-impl.xml
<p>
Definition of targets in <code>build-impl.xml</code> which may be called or
overridden in <code>build.xml</code>. XXX not yet formally specified.
</p>
</li>
</ol>
</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 2016-10-4 with count of newer 0--><!--year ok-->
<li>Oct 4 '16 <a href="apichanges.html#J2SEProjectBuilder-DefaultModuleProperties">Added a method to create default module properties</a>
<p>
Added a method into the <code>J2SEProjectBuilder</code> to create default module properties for J2SEProject.
</p>
</li>
<!--Checking date 2013-9-24 with count of newer 1--><!--year ok-->
<li>Sep 24 '13 <a href="apichanges.html#J2SEBuildPropertiesProvider">Added SPI to allow J2SE Project extensions to supply additional build properties</a>
<p>
Added SPI to allow J2SE Project extensions to supply additional build properties.
</p>
</li>
<!--Checking date 2013-9-24 with count of newer 1--><!--year ok-->
<li>Sep 24 '13 <a href="apichanges.html#J2SERuntimePlatformProvider">Added SPI to allow J2SE Project extensions to provide allowed runtime java platforms</a>
<p>
Added J2SERuntimePlatformProvider SPI to allow J2SE Project extensions to provide allowed runtime java platforms
to J2SE Project customizer.
</p>
</li>
<!--Checking date 2013-5-2 with count of newer 3--><!--year ok-->
<li>May 2 '13 <a href="apichanges.html#J2SEProjectPlatform">Added API to allow J2SE Project extension to get and set active project platform</a>
<p>
Added a new friend API to allow J2SE Project extension to obtain and set active project platform.
</p>
</li>
<!--Checking date 2013-3-21 with count of newer 4--><!--year ok-->
<li>Mar 21 '13 <a href="apichanges.html#J2SECategoryExtensionProvider"></a>
<p>
<code>J2SECategoryExtensionProvider</code> so far restricted the possibility to extend
panels in Project Properties dialog to Run and Package panels only. Now it is possible
to extend also Application panel.
</p>
</li>
<!--Checking date 2013-2-25 with count of newer 5--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2011-8-17 with count of newer 6--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2011-8-17 with count of newer 6--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2007-1-4 with count of newer 8--><!--Skipped as the amount of changes is too big-->
</ul>
<h3>Use Cases</h3>
<answer id="arch-usecases">
<p>
Covered by UI specification and design document.
</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-dtd">
<h5>Group of dtd 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>j2se-project.xsd</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="dtd-j2se-project.xsd"><a href="http://www.netbeans.org/ns/j2se-project/1.xsd">
...//www.netbeans.org/ns/j2se-project/1.xsd</a>
<p></p>
<p></p>
<p>
Definition of j2seproject-specific portions of <code>project.xml</code> (1st revision).
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>j2se-project-2.xsd</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="dtd-j2se-project-2.xsd"><a href="http://www.netbeans.org/ns/j2se-project/2.xsd">
...//www.netbeans.org/ns/j2se-project/2.xsd</a>
<p></p>
<p></p>
<p>
Definition of j2seproject-specific portions of <code>project.xml</code> (2nd revision).
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-java.io.File">
<h5>Group of java.io.File 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>project.properties</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java.io.File-project.properties">
<p></p>
<p>
Definition of recognized keys in <code>project.properties</code> and/or
<code>private.properties</code>. XXX not yet formally specified.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>build-impl.xml</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java.io.File-build-impl.xml">
<p></p>
<p>
Definition of targets in <code>build-impl.xml</code> which may be called or
overridden in <code>build.xml</code>. XXX not yet formally specified.
</p>
<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>
<tr class="tabler">
<td>J2SEPropertyEvaluator</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="java-J2SEPropertyEvaluator">
<p></p>
<p>
Module provides public package <code>org.netbeans.modules.java.j2seproject.api</code> with
interface for resolving values of project properties defined in project.properties and private.properties files.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-org.apache.tools.ant.Task">
<h5>Group of org.apache.tools.ant.Task 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-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>j2seproject.transparentUpdate</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="systemproperty-j2seproject.transparentUpdate">
<p></p>
If the property is set to <code>true</code> the project updates metadata of <code>project.xml</code> from
the namespace <code>http://www.netbeans.org/ns/j2se-project/1</code> to
<code>http://www.netbeans.org/ns/j2se-project/2</code> without explicit user confirmation.
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-layer">
<h5>Group of layer 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>J2SEProjectCustomizer</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="layer-J2SEProjectCustomizer">
<p></p>
<p>
"Projects/org-netbeans-modules-java-j2seproject/Customizer" folder's content is used to construct the project's customizer.
It's content is expected to be <code>ProjectCustomizer.CompositeCategoryProvider</code> instances.
The lookup passed to the panels contains an instance of <code>Project</code> and <code>org.netbeans.modules.java.j2seproject.ui.customizer.J2SEProjectProperties</code>
Please note that the latter is not part of any public APIs and you need implementation dependency to make use of it.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>J2SELogicalViewProvider</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="layer-J2SELogicalViewProvider">
<p></p>
<p>
"Projects/org-netbeans-modules-java-j2seproject/Nodes" folder's content is used to construct the project's child nodes.
It's content is expected to be <code>NodeFactory</code> instances.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>J2SELookup</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="layer-J2SELookup">
<p></p>
<p>
"Projects/org-netbeans-modules-java-j2seproject/Lookup" folder's content is used to construct the project's additional lookup.
It's content is expected to be <code>LookupProvider</code> instances. J2SE project provides <code>LookupMerger</code>s
for <code>Sources</code>, <code>PrivilegedTemplates</code> and <code>RecommendedTemplates</code>. Implementations added by 3rd parties
will be merged into a single instance in the project's lookup.
</p>
<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>
N/A
</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><a href="org/netbeans/modules/java/j2seproject/api/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/netbeans/modules/java/j2seproject/api/package-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.j2seproject/1 1.89.1 48</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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;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.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></small></p>
</body>
</html>