View All Attachments for Bug 52886

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Attachment #19452
API diff	patch	2005-01-04 09:46:11 UTC	62.81 KB	no flags	Details

Attachment #19453
generated new Javadoc for ReferenceHelper	text/html	2005-01-04 09:47:00 UTC	54.36 KB	no flags	Details

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0) on Mon Jan 03 13:44:23 CET 2005 -->
<TITLE>
ReferenceHelper (NetBeans Ant Project API)
</TITLE>

<META NAME="keywords" CONTENT="org.netbeans.spi.project.support.ant.ReferenceHelper class">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../javadoc.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="ReferenceHelper (NetBeans Ant Project API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ReferenceHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
&nbsp;</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/PropertyUtils.html" title="class in org.netbeans.spi.project.support.ant"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?org/netbeans/spi/project/support/ant/ReferenceHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ReferenceHelper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.netbeans.spi.project.support.ant</FONT>
<BR>
Class ReferenceHelper</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.netbeans.spi.project.support.ant.ReferenceHelper</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>ReferenceHelper</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
</PRE>

<P>
Helps manage inter-project references.
 Normally you would create an instance of this object and keep it in your
 project object in order to support <CODE>SubprojectProvider</CODE> and various
 operations that change settings which might refer to build artifacts from
 other projects: e.g. when changing the classpath for a Java-based project
 you would want to use this helper to scan potential classpath entries for
 JARs coming from other projects that you would like to be able to build
 as dependencies before your project is built.
 <p>
 You probably only need the higher-level methods such as <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact)"><CODE>addReference(org.netbeans.api.project.ant.AntArtifact)</CODE></A>
 and <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#removeReference(java.lang.String, java.lang.String)"><CODE>removeReference(String,String)</CODE></A>; the lower-level methods such as <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addRawReference(org.netbeans.spi.project.support.ant.ReferenceHelper.RawReference)"><CODE>addRawReference(org.netbeans.spi.project.support.ant.ReferenceHelper.RawReference)</CODE></A>
 are provided for completeness, but typical client code should not need them.
 <p>
 Only deals with references needed to support build artifacts coming from
 foreign projects. If for some reason you wish to store other kinds of
 references to foreign projects, you do not need this class; just store
 them however you wish, and be sure to create an appropriate <CODE>SubprojectProvider</CODE>.
 <p>
 Modification methods (add, remove) mark the project as modified but do not save it.
<P>

<P>
<HR>

<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->

<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A raw reference descriptor representing a link to a foreign project
 and some build artifact used from it.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#ReferenceHelper(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.AuxiliaryConfiguration, org.netbeans.spi.project.support.ant.PropertyEvaluator)">ReferenceHelper</A></B>(<A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html" title="class in org.netbeans.spi.project.support.ant">AntProjectHelper</A>&nbsp;helper,
                org.netbeans.spi.project.AuxiliaryConfiguration&nbsp;aux,
                <A HREF="../../../../../../org/netbeans/spi/project/support/ant/PropertyEvaluator.html" title="interface in org.netbeans.spi.project.support.ant">PropertyEvaluator</A>&nbsp;eval)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new reference helper.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addRawReference(org.netbeans.spi.project.support.ant.ReferenceHelper.RawReference)">addRawReference</A></B>(<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A>&nbsp;ref)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a raw reference to a foreign project artifact.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact)">addReference</A></B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>to add reference use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A>;
   to check whether reference exist or not use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#isReferenced(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>isReferenced(AntArtifact, URI)</CODE></A>.
   This method creates reference for the first artififact location only.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)">addReference</A></B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact,
             <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A>&nbsp;location)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a reference to an artifact's location coming from a foreign project.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(org.netbeans.api.project.ant.AntArtifact)">createForeignFileReference</A></B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A> instead</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(java.io.File, java.lang.String)">createForeignFileReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
                           <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;expectedArtifactType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an Ant-interpretable string referring to a file on disk.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.netbeans.spi.project.SubprojectProvider</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createSubprojectProvider()">createSubprojectProvider</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an object permitting this project to represent subprojects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyForeignFileReference(java.lang.String)">destroyForeignFileReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead which does exactly 
   the same but has more appropriate name</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)">destroyReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove a reference to a foreign file from the project.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#findArtifactAndLocation(java.lang.String)">findArtifactAndLocation</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try to find an <code>AntArtifact</code> object and location corresponding
 to a given reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getForeignFileReferenceAsArtifact(java.lang.String)">getForeignFileReferenceAsArtifact</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#findArtifactAndLocation(java.lang.String)"><CODE>findArtifactAndLocation(java.lang.String)</CODE></A> instead</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getRawReference(java.lang.String, java.lang.String)">getRawReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a particular raw reference from this project to another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getRawReferences()">getRawReferences</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of raw references from this project to others.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#isReferenced(org.netbeans.api.project.ant.AntArtifact, java.net.URI)">isReferenced</A></B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact,
             <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A>&nbsp;location)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether reference for artifact's location was already created by
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A> for this project or not.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#removeRawReference(java.lang.String, java.lang.String)">removeRawReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                   <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove a raw reference to an artifact coming from a foreign project.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#removeReference(java.lang.String)">removeReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;fileReference)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead; was unused anyway</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#removeReference(java.lang.String, java.lang.String)">removeReference</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead; was unused anyway</I></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ReferenceHelper(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.AuxiliaryConfiguration, org.netbeans.spi.project.support.ant.PropertyEvaluator)"><!-- --></A><H3>
ReferenceHelper</H3>
<PRE>
public <B>ReferenceHelper</B>(<A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html" title="class in org.netbeans.spi.project.support.ant">AntProjectHelper</A>&nbsp;helper,
                       org.netbeans.spi.project.AuxiliaryConfiguration&nbsp;aux,
                       <A HREF="../../../../../../org/netbeans/spi/project/support/ant/PropertyEvaluator.html" title="interface in org.netbeans.spi.project.support.ant">PropertyEvaluator</A>&nbsp;eval)</PRE>
<DL>
<DD>Create a new reference helper.
 It needs an <A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html" title="class in org.netbeans.spi.project.support.ant"><CODE>AntProjectHelper</CODE></A> object in order to update references
 in <code>project.xml</code>,
 as well as set project or private properties referring to the locations
 of foreign projects on disk.
 <p>
 The property evaluator may be used in <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getForeignFileReferenceAsArtifact(java.lang.String)"><CODE>getForeignFileReferenceAsArtifact(java.lang.String)</CODE></A>,
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html#toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)"><CODE>ReferenceHelper.RawReference.toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)</CODE></A>, or
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createSubprojectProvider()"><CODE>createSubprojectProvider()</CODE></A>. Typically this would
 be <A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html#getStandardPropertyEvaluator()"><CODE>AntProjectHelper.getStandardPropertyEvaluator()</CODE></A>. You can substitute
 a custom evaluator but be warned that this helper class assumes that
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html#PROJECT_PROPERTIES_PATH"><CODE>AntProjectHelper.PROJECT_PROPERTIES_PATH</CODE></A> and <A HREF="../../../../../../org/netbeans/spi/project/support/ant/AntProjectHelper.html#PRIVATE_PROPERTIES_PATH"><CODE>AntProjectHelper.PRIVATE_PROPERTIES_PATH</CODE></A>
 have their customary meanings; specifically that they are both used when evaluating
 properties (such as the location of a foreign project) and that private properties
 can override public properties.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>helper</CODE> - an Ant project helper object representing this project's configuration<DD><CODE>aux</CODE> - an auxiliary configuration provider needed to store references<DD><CODE>eval</CODE> - a property evaluator</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="addReference(org.netbeans.api.project.ant.AntArtifact)"><!-- --></A><H3>
addReference</H3>
<PRE>
public boolean <B>addReference</B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact)
                     throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>to add reference use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A>;
   to check whether reference exist or not use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#isReferenced(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>isReferenced(AntArtifact, URI)</CODE></A>.
   This method creates reference for the first artififact location only.</I>
<P>
<DD>Add a reference to an artifact coming from a foreign project.
 <p>
 For more info see <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>artifact</CODE> - the artifact to add
<DT><B>Returns:</B><DD>true if a reference or some property was actually added or modified,
         false if everything already existed and was not modified
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the artifact is not associated with a project</DL>
</DD>
</DL>
<HR>

<A NAME="addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><!-- --></A><H3>
addReference</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>addReference</B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact,
                           <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A>&nbsp;location)
                    throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Add a reference to an artifact's location coming from a foreign project.
 <p>
 Records the name of the foreign project.
 Normally the foreign project name is that project's code name,
 but it may be uniquified if that name is already taken to refer
 to a different project with the same code name.
 <p>
 Adds a project property if necessary to refer to its location of the foreign
 project - a shared property if the foreign project
 is <CODE>collocated</CODE> with this one, else a private property.
 This property is named <samp>project.<i>foreignProjectName</i></samp>.
 Example: <samp>project.mylib=../mylib</samp>
 <p>
 Adds a project property to refer to the artifact's location.
 This property is named <samp>reference.<i>foreignProjectName</i>.<i>targetName</i></samp>
 and will use <samp>${project.<i>foreignProjectName</i>}</samp> and be a shared
 property - unless the artifact location is an absolute URI, in which case the property
 will also be private.
 Example: <samp>reference.mylib.jar=${project.mylib}/dist/mylib.jar</samp>
 <p>
 Also records the artifact type, (relative) script path, and build and
 clean target names.
 <p>
 If the reference already exists (keyed by foreign project object
 and target name), nothing is done, unless some other field (script location,
 clean target name, or artifact type) needed to be updated, in which case
 the new information replaces the old. Similarly, the artifact location
 property is updated if necessary.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>artifact</CODE> - the artifact to add<DD><CODE>location</CODE> - the artifact's location to create reference to
<DT><B>Returns:</B><DD>name of reference which was created or already existed
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the artifact is not associated with a project
   or if the location is not artifact's location<DT><B>Since:</B></DT>
  <DD>X.XX</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isReferenced(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><!-- --></A><H3>
isReferenced</H3>
<PRE>
public boolean <B>isReferenced</B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact,
                            <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A>&nbsp;location)
                     throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Tests whether reference for artifact's location was already created by
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A> for this project or not. This
 method returns false also in case when reference exist but needs to be
 updated.
 <p>
 Acquires read access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>artifact</CODE> - the artifact to add<DD><CODE>location</CODE> - the artifact's location to create reference to
<DT><B>Returns:</B><DD>true if already referenced
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the artifact is not associated with a project
   or if the location is not artifact's location<DT><B>Since:</B></DT>
  <DD>X.XX</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="addRawReference(org.netbeans.spi.project.support.ant.ReferenceHelper.RawReference)"><!-- --></A><H3>
addRawReference</H3>
<PRE>
public boolean <B>addRawReference</B>(<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A>&nbsp;ref)</PRE>
<DL>
<DD>Add a raw reference to a foreign project artifact.
 Does not check if such a project already exists; does not create a project
 property to refer to it; does not do any backreference usage notifications.
 <p>
 If the reference already exists (keyed by foreign project name and target name),
 nothing is done, unless some other field (script location, clean target name,
 or artifact type) needed to be updated, in which case the new information
 replaces the old.
 <p>
 Note that since <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant"><CODE>ReferenceHelper.RawReference</CODE></A> is just a descriptor, it is not guaranteed
 that after adding one <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getRawReferences()"><CODE>getRawReferences()</CODE></A> or <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#getRawReference(java.lang.String, java.lang.String)"><CODE>getRawReference(java.lang.String, java.lang.String)</CODE></A>
 would return the identical object.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ref</CODE> - a raw reference descriptor
<DT><B>Returns:</B><DD>true if a reference was actually added or modified,
         false if it already existed and was not modified</DL>
</DD>
</DL>
<HR>

<A NAME="removeReference(java.lang.String, java.lang.String)"><!-- --></A><H3>
removeReference</H3>
<PRE>
public boolean <B>removeReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                               <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead; was unused anyway</I>
<P>
<DD>Remove a reference to an artifact coming from a foreign project.
 <p>
 The property giving the location of the artifact is removed if it existed.
 <p>
 If this was the last reference to the foreign project, its location
 property is removed as well.
 <p>
 If the reference does not exist, nothing is done.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>foreignProjectName</CODE> - the local name of the foreign project
                           (usually its code name)<DD><CODE>id</CODE> - the ID of the build artifact (usually build target name)
<DT><B>Returns:</B><DD>true if a reference or some property was actually removed,
         false if the reference was not there and no property was removed</DL>
</DD>
</DL>
<HR>

<A NAME="removeReference(java.lang.String)"><!-- --></A><H3>
removeReference</H3>
<PRE>
public boolean <B>removeReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;fileReference)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead; was unused anyway</I>
<P>
<DD>Remove reference to a file.
 <p>
 If the reference does not exist, nothing is done.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fileReference</CODE> - file reference as created by 
    <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(java.io.File, java.lang.String)"><CODE>createForeignFileReference(File, String)</CODE></A>
<DT><B>Returns:</B><DD>true if the reference was actually removed; otherwise false</DL>
</DD>
</DL>
<HR>

<A NAME="removeRawReference(java.lang.String, java.lang.String)"><!-- --></A><H3>
removeRawReference</H3>
<PRE>
public boolean <B>removeRawReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                                  <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</PRE>
<DL>
<DD>Remove a raw reference to an artifact coming from a foreign project.
 Does not attempt to manipulate backreferences in the foreign project
 nor project properties.
 <p>
 If the reference does not exist, nothing is done.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>foreignProjectName</CODE> - the local name of the foreign project
                           (usually its code name)<DD><CODE>id</CODE> - the ID of the build artifact (usually build target name)
<DT><B>Returns:</B><DD>true if a reference was actually removed, false if it was not there</DL>
</DD>
</DL>
<HR>

<A NAME="getRawReferences()"><!-- --></A><H3>
getRawReferences</H3>
<PRE>
public <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A>[] <B>getRawReferences</B>()</PRE>
<DL>
<DD>Get a list of raw references from this project to others.
 If necessary, you may use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html#toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)"><CODE>ReferenceHelper.RawReference.toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)</CODE></A> to get
 live information from each reference, such as its associated project.
 <p>
 Acquires read access.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a (possibly empty) list of raw references from this project</DL>
</DD>
</DL>
<HR>

<A NAME="getRawReference(java.lang.String, java.lang.String)"><!-- --></A><H3>
getRawReference</H3>
<PRE>
public <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant">ReferenceHelper.RawReference</A> <B>getRawReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;foreignProjectName,
                                                    <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</PRE>
<DL>
<DD>Get a particular raw reference from this project to another.
 If necessary, you may use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html#toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)"><CODE>ReferenceHelper.RawReference.toAntArtifact(org.netbeans.spi.project.support.ant.ReferenceHelper)</CODE></A> to get
 live information from each reference, such as its associated project.
 <p>
 Acquires read access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>foreignProjectName</CODE> - the local name of the foreign project
                           (usually its code name)<DD><CODE>id</CODE> - the ID of the build artifact (usually the build target name)
<DT><B>Returns:</B><DD>the specified raw reference from this project,
         or null if none such could be found</DL>
</DD>
</DL>
<HR>

<A NAME="createForeignFileReference(java.io.File, java.lang.String)"><!-- --></A><H3>
createForeignFileReference</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>createForeignFileReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
                                         <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;expectedArtifactType)</PRE>
<DL>
<DD>Create an Ant-interpretable string referring to a file on disk.
 If the file refers to a known Ant artifact according to
 <A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifactQuery.html#findArtifactFromFile(java.io.File)"><CODE>AntArtifactQuery.findArtifactFromFile(java.io.File)</CODE></A>, of the expected type
 and associated with a particular project,
 the behavior is identical to <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(org.netbeans.api.project.ant.AntArtifact)"><CODE>createForeignFileReference(AntArtifact)</CODE></A>.
 Otherwise, a reference for the file is created. The file path will
 be relative in case <CODE>CollocationQuery.areCollocated(java.io.File, java.io.File)</CODE> says that
 the file is collocated with this project's main directory, else it
 will be an absolute path.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - a file to refer to (need not currently exist)<DD><CODE>expectedArtifactType</CODE> - the required <A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html#getType()"><CODE>AntArtifact.getType()</CODE></A>
<DT><B>Returns:</B><DD>a string which can refer to that file somehow</DL>
</DD>
</DL>
<HR>

<A NAME="createForeignFileReference(org.netbeans.api.project.ant.AntArtifact)"><!-- --></A><H3>
createForeignFileReference</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>createForeignFileReference</B>(<A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A>&nbsp;artifact)
                                  throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A> instead</I>
<P>
<DD>Create an Ant-interpretable string referring to a known build artifact file.
 Simply calls <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact)"><CODE>addReference(org.netbeans.api.project.ant.AntArtifact)</CODE></A> and returns an Ant string which will
 refer to that artifact correctly.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>artifact</CODE> - a known build artifact to refer to
<DT><B>Returns:</B><DD>a string which can refer to that artifact file somehow
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the artifact is not associated with a project</DL>
</DD>
</DL>
<HR>

<A NAME="getForeignFileReferenceAsArtifact(java.lang.String)"><!-- --></A><H3>
getForeignFileReferenceAsArtifact</H3>
<PRE>
public <A HREF="../../../../../../org/netbeans/api/project/ant/AntArtifact.html" title="class in org.netbeans.api.project.ant">AntArtifact</A> <B>getForeignFileReferenceAsArtifact</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#findArtifactAndLocation(java.lang.String)"><CODE>findArtifactAndLocation(java.lang.String)</CODE></A> instead</I>
<P>
<DD>Try to find an <code>AntArtifact</code> object corresponding to a given
 foreign file reference.
 If the supplied string is not a recognized reference to a build
 artifact, returns null.
 <p>Acquires read access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - a reference string as present in an Ant property
<DT><B>Returns:</B><DD>a corresponding Ant artifact object if there is one, else null</DL>
</DD>
</DL>
<HR>

<A NAME="findArtifactAndLocation(java.lang.String)"><!-- --></A><H3>
findArtifactAndLocation</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>findArtifactAndLocation</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</PRE>
<DL>
<DD>Try to find an <code>AntArtifact</code> object and location corresponding
 to a given reference. If the supplied string is not a recognized 
 reference to a build artifact, returns null.
 <p>
 Acquires read access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - a reference string as present in an Ant property and as
   created by <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A>
<DT><B>Returns:</B><DD>always returns array of two items. The items may be null. First
   one is instance of AntArtifact and second is instance of URI and is 
   AntArtifact's location<DT><B>Since:</B></DT>
  <DD>X.XX</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="destroyForeignFileReference(java.lang.String)"><!-- --></A><H3>
destroyForeignFileReference</H3>
<PRE>
public void <B>destroyForeignFileReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> instead which does exactly 
   the same but has more appropriate name</I>
<P>
<DD>Remove a reference to a foreign file from the project.
 See <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#destroyReference(java.lang.String)"><CODE>destroyReference(java.lang.String)</CODE></A> for more information.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - an Ant-interpretable foreign file reference as created e.g.
                  by <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(java.io.File, java.lang.String)"><CODE>createForeignFileReference(File,String)</CODE></A> or
                  by <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(org.netbeans.api.project.ant.AntArtifact)"><CODE>createForeignFileReference(AntArtifact)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="destroyReference(java.lang.String)"><!-- --></A><H3>
destroyReference</H3>
<PRE>
public boolean <B>destroyReference</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reference)</PRE>
<DL>
<DD>Remove a reference to a foreign file from the project.
 If the passed string consists of an Ant property reference corresponding to
 a known inter-project reference created by 
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#addReference(org.netbeans.api.project.ant.AntArtifact, java.net.URI)"><CODE>addReference(AntArtifact, URI)</CODE></A> or file reference created by
 <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(java.io.File, java.lang.String)"><CODE>createForeignFileReference(File, String)</CODE></A>, that reference is removed.
 Since this would break any other identical foreign
 file references present in the project, you should first confirm that this
 reference was the last one of its kind (by string match).
 <p>
 If the passed string is anything else (i.e. a plain file path, relative or
 absolute), nothing is done.
 <p>
 Acquires write access.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - an Ant-interpretable foreign file reference as created e.g.
                  by <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(java.io.File, java.lang.String)"><CODE>createForeignFileReference(File,String)</CODE></A> or
                  by <A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.html#createForeignFileReference(org.netbeans.api.project.ant.AntArtifact)"><CODE>createForeignFileReference(AntArtifact)</CODE></A>
<DT><B>Returns:</B><DD>true if reference was really destroyed or not<DT><B>Since:</B></DT>
  <DD>X.XX</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="createSubprojectProvider()"><!-- --></A><H3>
createSubprojectProvider</H3>
<PRE>
public org.netbeans.spi.project.SubprojectProvider <B>createSubprojectProvider</B>()</PRE>
<DL>
<DD>Create an object permitting this project to represent subprojects.
 Would be placed into the project's lookup.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a subproject provider object suitable for the project lookup<DT><B>See Also:</B><DD><CODE>Project.getLookup()</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ReferenceHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
&nbsp;</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/PropertyUtils.html" title="class in org.netbeans.spi.project.support.ant"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/netbeans/spi/project/support/ant/ReferenceHelper.RawReference.html" title="class in org.netbeans.spi.project.support.ant"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?org/netbeans/spi/project/support/ant/ReferenceHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ReferenceHelper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<span class=footnote>Built on January 3 2005.&nbsp;&nbsp;|&nbsp;&nbsp;Portions Copyright 1997-2004 Sun Microsystems, Inc. All rights reserved.</span>
</BODY>
</HTML>

Attachment #19454
full diff	patch	2005-01-04 09:47:35 UTC	128.84 KB	no flags	Details