blob: e75715f8cf7d4141271c1318e4f4b2d9e9eaa2f0 [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:35:41 BST 2018 -->
<title>Overview (External Libraries)</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 (External Libraries)";
}
}
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.project.libraries/1 1.55.1 </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">External Libraries<br/><span style='font-style:normal; font-size:medium; font-weight:normal; background-color:#ffffff;'><a href='http://wiki.netbeans.org/API_Stability#Official' target='_blank'>Official</a></span></h1>
</div>
<div class="header">
<div class="subTitle">
<div class="block">
ProjectLibrariesAPI
The Project Libraries API permits definitions of <q>libraries</q> to be
registered and persisted.</div>
</div>
<p>See: <a href="#overview.description">Description</a></p>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="External Libraries table, listing packages, and an explanation">
<caption><span>External Libraries</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/api/project/libraries/package-summary.html">org.netbeans.api.project.libraries</a></td>
<td class="colLast">
<div class="block">Representation of a library, and the ability to find the installed libraries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/netbeans/spi/project/libraries/package-summary.html">org.netbeans.spi.project.libraries</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/netbeans/spi/project/libraries/support/package-summary.html">org.netbeans.spi.project.libraries.support</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer"><a name="overview.description">
<!-- -->
</a>
<div class="block"><p>
ProjectLibrariesAPI
The Project Libraries API permits definitions of <q>libraries</q> to be
registered and persisted. Library type providers may be registered and can
construct memory objects corresponding to persistent library definitions.
</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 2015-1-16 with count of newer 0--><!--year ok-->
<li>Jan 16 '15 <a href="apichanges.html#LibrariesSupport-getLibraryImplementation">Added <code>LibrariesSupport.getLibraryImplementation</code>to obtain SPI for <code>Library</code></a>
<p>
Added <code>LibrariesSupport.getLibraryImplementation</code> into SPI support to obtain the SPI
for given <code>Library</code>. Needed to remove an implementation dependency among project.libraries and project.libraries.ui.
</p>
</li>
<!--Checking date 2014-7-1 with count of newer 1--><!--year ok-->
<li>Jul 1 '14 <a href="apichanges.html#Libraries-UI-split">Moved the UI part of the <code>project.libraries</code> into a new <code>project.libraries.ui</code>module</a>
<p>
Moved the UI part of the <code>project.libraries</code> into a new <code>project.libraries.ui</code>module.
Added a new integration SPI and SPI support methods.
</p>
</li>
<!--Checking date 2011-8-30 with count of newer 2--><!--year ok-->
<li>Aug 30 '11 <a href="apichanges.html#LibrariesSupport.createLibraryImplementation3">Added a new factory method to create default implementation of <code>LibraryImplementation3</code></a>
<p>
Added a new factory method to create default implementation of <code>LibraryImplementation3</code>.
</p>
</li>
<!--Checking date 2011-6-19 with count of newer 3--><!--year ok-->
<li>Jun 19 '11 <a href="apichanges.html#create-library-with-properties">Added methods to create a new <code>Library</code> with properties</a>
<p>
Added new factory methods into <code>LibraryManager</code> to create a <code>Library</code>
with associated properties.
</p>
</li>
<!--Checking date 2011-6-16 with count of newer 4--><!--year ok-->
<li>Jun 16 '11 <a href="apichanges.html#library-display-name">Allow user created library to provide display name</a>
<p>
Added <code>displayName</code> property into the <code>Library</code>'s SPI
allowing an implementor to provide the a display name of the <code>Library</code>
which differs from the system (identifying) name.
</p>
</li>
<!--Checking date 2011-3-14 with count of newer 5--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2011-3-13 with count of newer 6--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2008-3-27 with count of newer 7--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2008-1-22 with count of newer 8--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2007-8-31 with count of newer 9--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2006-8-11 with count of newer 10--><!--Skipped as the amount of changes is too big-->
<!--Checking date 2004-12-22 with count of newer 11--><!--Skipped as the amount of changes is too big-->
</ul>
<h3>Use Cases</h3>
<answer id="arch-usecases">
<p>
Different technology support modules will supply definitions of different
kinds of libraries, e.g. Java JARs, that may be reused in user projects.
Modules may register library predefinitions to wrap libraries they bundle.
Project type providers can refer to available libraries in customizer dialogs.
</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-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>ProjectLibrariesAPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ProjectLibrariesAPI">
<p></p>
The Project Libraries API permits definitions of <q>libraries</q> to be
registered and persisted. Library type providers may be registered and can
construct memory objects corresponding to persistent library definitions.
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<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>Library-Declaration-DTD</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="dtd-Library-Declaration-DTD"><a href="http://www.netbeans.org/dtds/library-declaration-1_0.dtd">
.../dtds/library-declaration-1_0.dtd</a>
<p></p>
<p></p>
<p>
An XML DTD is used to define the library definition format.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<h3>Implementation Details</h3>
<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>
Nothing.
<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.project.libraries/1 1.55.1 </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>