Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\ProjectHelper.html
<!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_22) on Mon Feb 01 19:35:31 EST 2010 --> <TITLE> ProjectHelper (Apache Ant API) </TITLE> <META NAME="keywords" CONTENT="org.apache.tools.ant.ProjectHelper class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="ProjectHelper (Apache Ant 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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/tools/ant/ProjectHelperRepository.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/tools/ant/ProjectHelper.html" target="_top"><B>FRAMES</B></A> <A HREF="ProjectHelper.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.apache.tools.ant</FONT> <BR> Class ProjectHelper</H2> <PRE> java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.tools.ant.ProjectHelper</B> </PRE> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/tools/ant/helper/ProjectHelper2.html" title="class in org.apache.tools.ant.helper">ProjectHelper2</A>, <A HREF="../../../../org/apache/tools/ant/helper/ProjectHelperImpl.html" title="class in org.apache.tools.ant.helper">ProjectHelperImpl</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>ProjectHelper</B><DT>extends java.lang.Object</DL> </PRE> <P> Configures a Project (complete with Targets and Tasks) based on a build file. It'll rely on a plugin to do the actual processing of the file. <p> This class also provide static wrappers for common introspection. <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_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>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_CORE_URI">ANT_CORE_URI</A></B></CODE> <BR> The URI for ant name space</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_CURRENT_URI">ANT_CURRENT_URI</A></B></CODE> <BR> The URI for antlib current definitions</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_TYPE">ANT_TYPE</A></B></CODE> <BR> Polymorphic attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANTLIB_URI">ANTLIB_URI</A></B></CODE> <BR> The URI for defined types/tasks - the format is antlib:<package></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#HELPER_PROPERTY">HELPER_PROPERTY</A></B></CODE> <BR> Name of JVM system property which provides the name of the ProjectHelper class to use.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#PROJECTHELPER_REFERENCE">PROJECTHELPER_REFERENCE</A></B></CODE> <BR> name of project helper reference that we add to a project</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#SERVICE_ID">SERVICE_ID</A></B></CODE> <BR> The service identifier in jars which provide Project Helper implementations.</TD> </TR> </TABLE> <!-- ======== 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/apache/tools/ant/ProjectHelper.html#ProjectHelper()">ProjectHelper</A></B>()</CODE> <BR> Default constructor</TD> </TR> </TABLE> <!-- ========== 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>static <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addLocationToBuildException(org.apache.tools.ant.BuildException, org.apache.tools.ant.Location)">addLocationToBuildException</A></B>(<A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> ex, <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> newLocation)</CODE> <BR> Add location to build exception.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addText(org.apache.tools.ant.Project, java.lang.Object, char[], int, int)">addText</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object target, char[] buf, int start, int count)</CODE> <BR> Adds the content of #PCDATA sections to an element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addText(org.apache.tools.ant.Project, java.lang.Object, java.lang.String)">addText</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object target, java.lang.String text)</CODE> <BR> Adds the content of #PCDATA sections to an element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#canParseAntlibDescriptor(org.apache.tools.ant.types.Resource)">canParseAntlibDescriptor</A></B>(<A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> r)</CODE> <BR> Whether this instance of ProjectHelper can parse an Antlib descriptor given by the URL and return its content as an UnknownElement ready to be turned into an Antlib task.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#canParseBuildFile(org.apache.tools.ant.types.Resource)">canParseBuildFile</A></B>(<A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> buildFile)</CODE> <BR> Check if the helper supports the kind of file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#configure(java.lang.Object, org.xml.sax.AttributeList, org.apache.tools.ant.Project)">configure</A></B>(java.lang.Object target, org.xml.sax.AttributeList attrs, <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project)</CODE> <BR> <B>Deprecated.</B> <I>since 1.6.x. Use IntrospectionHelper for each property.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#configureProject(org.apache.tools.ant.Project, java.io.File)">configureProject</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.io.File buildFile)</CODE> <BR> Configures the project with the contents of the specified build file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#extractNameFromComponentName(java.lang.String)">extractNameFromComponentName</A></B>(java.lang.String componentName)</CODE> <BR> extract the element name from a component name</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#extractUriFromComponentName(java.lang.String)">extractUriFromComponentName</A></B>(java.lang.String componentName)</CODE> <BR> extract a uri from a component name</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#genComponentName(java.lang.String, java.lang.String)">genComponentName</A></B>(java.lang.String uri, java.lang.String name)</CODE> <BR> Map a namespaced {uri,name} to an internal string format.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.ClassLoader</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getContextClassLoader()">getContextClassLoader</A></B>()</CODE> <BR> <B>Deprecated.</B> <I>since 1.6.x. Use LoaderUtils.getContextClassLoader()</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getCurrentPrefixSeparator()">getCurrentPrefixSeparator</A></B>()</CODE> <BR> The separator between the prefix and the target name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getCurrentTargetPrefix()">getCurrentTargetPrefix</A></B>()</CODE> <BR> The prefix to prepend to imported target names.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getDefaultBuildFile()">getDefaultBuildFile</A></B>()</CODE> <BR> The file name of the build script to be parsed if none specified on the command line</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getImportStack()">getImportStack</A></B>()</CODE> <BR> Import stack.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../org/apache/tools/ant/ProjectHelper.html" title="class in org.apache.tools.ant">ProjectHelper</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getProjectHelper()">getProjectHelper</A></B>()</CODE> <BR> Get the first project helper found in the classpath</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#isInIncludeMode()">isInIncludeMode</A></B>()</CODE> <BR> Whether the current file should be read in include as opposed to import mode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parse(org.apache.tools.ant.Project, java.lang.Object)">parse</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object source)</CODE> <BR> Parses the project file, configuring the project as it goes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant">UnknownElement</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parseAntlibDescriptor(org.apache.tools.ant.Project, org.apache.tools.ant.types.Resource)">parseAntlibDescriptor</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> containingProject, <A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> source)</CODE> <BR> Parse the given URL as an antlib descriptor and return the content as something that can be turned into an Antlib task.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parsePropertyString(java.lang.String, java.util.Vector, java.util.Vector)">parsePropertyString</A></B>(java.lang.String value, java.util.Vector fragments, java.util.Vector propertyRefs)</CODE> <BR> <B>Deprecated.</B> <I>since 1.6.x. Use PropertyHelper.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#replaceProperties(org.apache.tools.ant.Project, java.lang.String)">replaceProperties</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.String value)</CODE> <BR> <B>Deprecated.</B> <I>since 1.6.x. Use project.replaceProperties().</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#replaceProperties(org.apache.tools.ant.Project, java.lang.String, java.util.Hashtable)">replaceProperties</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.String value, java.util.Hashtable keys)</CODE> <BR> <B>Deprecated.</B> <I>since 1.6.x. Use PropertyHelper.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#setCurrentPrefixSeparator(java.lang.String)">setCurrentPrefixSeparator</A></B>(java.lang.String sep)</CODE> <BR> Sets the separator between the prefix and the target name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#setCurrentTargetPrefix(java.lang.String)">setCurrentTargetPrefix</A></B>(java.lang.String prefix)</CODE> <BR> Sets the prefix to prepend to imported target names.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#setInIncludeMode(boolean)">setInIncludeMode</A></B>(boolean includeMode)</CODE> <BR> Sets whether the current file should be read in include as opposed to import mode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#storeChild(org.apache.tools.ant.Project, java.lang.Object, java.lang.Object, java.lang.String)">storeChild</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object parent, java.lang.Object child, java.lang.String tag)</CODE> <BR> Stores a configured child element within its parent object.</TD> </TR> </TABLE> <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.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_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>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="ANT_CORE_URI"><!-- --></A><H3> ANT_CORE_URI</H3> <PRE> public static final java.lang.String <B>ANT_CORE_URI</B></PRE> <DL> <DD>The URI for ant name space <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_CORE_URI">Constant Field Values</A></DL> </DL> <HR> <A NAME="ANT_CURRENT_URI"><!-- --></A><H3> ANT_CURRENT_URI</H3> <PRE> public static final java.lang.String <B>ANT_CURRENT_URI</B></PRE> <DL> <DD>The URI for antlib current definitions <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_CURRENT_URI">Constant Field Values</A></DL> </DL> <HR> <A NAME="ANTLIB_URI"><!-- --></A><H3> ANTLIB_URI</H3> <PRE> public static final java.lang.String <B>ANTLIB_URI</B></PRE> <DL> <DD>The URI for defined types/tasks - the format is antlib:<package> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANTLIB_URI">Constant Field Values</A></DL> </DL> <HR> <A NAME="ANT_TYPE"><!-- --></A><H3> ANT_TYPE</H3> <PRE> public static final java.lang.String <B>ANT_TYPE</B></PRE> <DL> <DD>Polymorphic attribute <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_TYPE">Constant Field Values</A></DL> </DL> <HR> <A NAME="HELPER_PROPERTY"><!-- --></A><H3> HELPER_PROPERTY</H3> <PRE> public static final java.lang.String <B>HELPER_PROPERTY</B></PRE> <DL> <DD>Name of JVM system property which provides the name of the ProjectHelper class to use. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.HELPER_PROPERTY">Constant Field Values</A></DL> </DL> <HR> <A NAME="SERVICE_ID"><!-- --></A><H3> SERVICE_ID</H3> <PRE> public static final java.lang.String <B>SERVICE_ID</B></PRE> <DL> <DD>The service identifier in jars which provide Project Helper implementations. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.SERVICE_ID">Constant Field Values</A></DL> </DL> <HR> <A NAME="PROJECTHELPER_REFERENCE"><!-- --></A><H3> PROJECTHELPER_REFERENCE</H3> <PRE> public static final java.lang.String <B>PROJECTHELPER_REFERENCE</B></PRE> <DL> <DD>name of project helper reference that we add to a project <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.PROJECTHELPER_REFERENCE">Constant Field Values</A></DL> </DL> <!-- ========= 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="ProjectHelper()"><!-- --></A><H3> ProjectHelper</H3> <PRE> public <B>ProjectHelper</B>()</PRE> <DL> <DD>Default constructor <P> </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="configureProject(org.apache.tools.ant.Project, java.io.File)"><!-- --></A><H3> configureProject</H3> <PRE> public static void <B>configureProject</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.io.File buildFile) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Configures the project with the contents of the specified build file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project to configure. Must not be <code>null</code>.<DD><CODE>buildFile</CODE> - A build file giving the project's configuration. Must not be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration is invalid or cannot be read</DL> </DD> </DL> <HR> <A NAME="getImportStack()"><!-- --></A><H3> getImportStack</H3> <PRE> public java.util.Vector <B>getImportStack</B>()</PRE> <DL> <DD>Import stack. Used to keep track of imported files. Error reporting should display the import path. <P> <DD><DL> <DT><B>Returns:</B><DD>the stack of import source objects.</DL> </DD> </DL> <HR> <A NAME="getCurrentTargetPrefix()"><!-- --></A><H3> getCurrentTargetPrefix</H3> <PRE> public static java.lang.String <B>getCurrentTargetPrefix</B>()</PRE> <DL> <DD>The prefix to prepend to imported target names. <p>May be set by <import>'s as attribute.</p> <P> <DD><DL> <DT><B>Returns:</B><DD>the configured prefix or null<DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="setCurrentTargetPrefix(java.lang.String)"><!-- --></A><H3> setCurrentTargetPrefix</H3> <PRE> public static void <B>setCurrentTargetPrefix</B>(java.lang.String prefix)</PRE> <DL> <DD>Sets the prefix to prepend to imported target names. <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="getCurrentPrefixSeparator()"><!-- --></A><H3> getCurrentPrefixSeparator</H3> <PRE> public static java.lang.String <B>getCurrentPrefixSeparator</B>()</PRE> <DL> <DD>The separator between the prefix and the target name. <p>May be set by <import>'s prefixSeperator attribute.</p> <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="setCurrentPrefixSeparator(java.lang.String)"><!-- --></A><H3> setCurrentPrefixSeparator</H3> <PRE> public static void <B>setCurrentPrefixSeparator</B>(java.lang.String sep)</PRE> <DL> <DD>Sets the separator between the prefix and the target name. <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="isInIncludeMode()"><!-- --></A><H3> isInIncludeMode</H3> <PRE> public static boolean <B>isInIncludeMode</B>()</PRE> <DL> <DD>Whether the current file should be read in include as opposed to import mode. <p>In include mode included targets are only known by their prefixed names and their depends lists get rewritten so that all dependencies get the prefix as well.</p> <p>In import mode imported targets are known by an adorned as well as a prefixed name and the unadorned target may be overwritten in the importing build file. The depends list of the imported targets is not modified at all.</p> <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="setInIncludeMode(boolean)"><!-- --></A><H3> setInIncludeMode</H3> <PRE> public static void <B>setInIncludeMode</B>(boolean includeMode)</PRE> <DL> <DD>Sets whether the current file should be read in include as opposed to import mode. <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="parse(org.apache.tools.ant.Project, java.lang.Object)"><!-- --></A><H3> parse</H3> <PRE> public void <B>parse</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object source) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Parses the project file, configuring the project as it goes. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project for the resulting ProjectHelper to configure. Must not be <code>null</code>.<DD><CODE>source</CODE> - The source for XML configuration. A helper must support at least File, for backward compatibility. Helpers may support URL, InputStream, etc or specialized types. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration is invalid or cannot be read<DT><B>Since:</B></DT> <DD>Ant1.5</DD> </DL> </DD> </DL> <HR> <A NAME="getProjectHelper()"><!-- --></A><H3> getProjectHelper</H3> <PRE> public static <A HREF="../../../../org/apache/tools/ant/ProjectHelper.html" title="class in org.apache.tools.ant">ProjectHelper</A> <B>getProjectHelper</B>()</PRE> <DL> <DD>Get the first project helper found in the classpath <P> <DD><DL> <DT><B>Returns:</B><DD>an project helper, never <code>null</code><DT><B>See Also:</B><DD><CODE>#getHelpers()</CODE></DL> </DD> </DL> <HR> <A NAME="getContextClassLoader()"><!-- --></A><H3> getContextClassLoader</H3> <PRE> public static java.lang.ClassLoader <B>getContextClassLoader</B>()</PRE> <DL> <DD><B>Deprecated.</B> <I>since 1.6.x. Use LoaderUtils.getContextClassLoader()</I> <P> <DD>JDK1.1 compatible access to the context class loader. Cut & paste from JAXP. <P> <DD><DL> <DT><B>Returns:</B><DD>the current context class loader, or <code>null</code> if the context class loader is unavailable.</DL> </DD> </DL> <HR> <A NAME="configure(java.lang.Object, org.xml.sax.AttributeList, org.apache.tools.ant.Project)"><!-- --></A><H3> configure</H3> <PRE> public static void <B>configure</B>(java.lang.Object target, org.xml.sax.AttributeList attrs, <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>since 1.6.x. Use IntrospectionHelper for each property.</I> <P> <DD>Configures an object using an introspection handler. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>target</CODE> - The target object to be configured. Must not be <code>null</code>.<DD><CODE>attrs</CODE> - A list of attributes to configure within the target. Must not be <code>null</code>.<DD><CODE>project</CODE> - The project containing the target. Must not be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any of the attributes can't be handled by the target</DL> </DD> </DL> <HR> <A NAME="addText(org.apache.tools.ant.Project, java.lang.Object, char[], int, int)"><!-- --></A><H3> addText</H3> <PRE> public static void <B>addText</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object target, char[] buf, int start, int count) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Adds the content of #PCDATA sections to an element. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the target. Must not be <code>null</code>.<DD><CODE>target</CODE> - The target object to be configured. Must not be <code>null</code>.<DD><CODE>buf</CODE> - A character array of the text within the element. Will not be <code>null</code>.<DD><CODE>start</CODE> - The start element in the array.<DD><CODE>count</CODE> - The number of characters to read from the array. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the target object doesn't accept text</DL> </DD> </DL> <HR> <A NAME="addText(org.apache.tools.ant.Project, java.lang.Object, java.lang.String)"><!-- --></A><H3> addText</H3> <PRE> public static void <B>addText</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object target, java.lang.String text) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Adds the content of #PCDATA sections to an element. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the target. Must not be <code>null</code>.<DD><CODE>target</CODE> - The target object to be configured. Must not be <code>null</code>.<DD><CODE>text</CODE> - Text to add to the target. May be <code>null</code>, in which case this method call is a no-op. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the target object doesn't accept text</DL> </DD> </DL> <HR> <A NAME="storeChild(org.apache.tools.ant.Project, java.lang.Object, java.lang.Object, java.lang.String)"><!-- --></A><H3> storeChild</H3> <PRE> public static void <B>storeChild</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.Object parent, java.lang.Object child, java.lang.String tag)</PRE> <DL> <DD>Stores a configured child element within its parent object. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - Project containing the objects. May be <code>null</code>.<DD><CODE>parent</CODE> - Parent object to add child to. Must not be <code>null</code>.<DD><CODE>child</CODE> - Child object to store in parent. Should not be <code>null</code>.<DD><CODE>tag</CODE> - Name of element which generated the child. May be <code>null</code>, in which case the child is not stored.</DL> </DD> </DL> <HR> <A NAME="replaceProperties(org.apache.tools.ant.Project, java.lang.String)"><!-- --></A><H3> replaceProperties</H3> <PRE> public static java.lang.String <B>replaceProperties</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.String value) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>since 1.6.x. Use project.replaceProperties().</I> <P> <DD>Replaces <code>${xxx}</code> style constructions in the given value with the string value of the corresponding properties. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the properties to replace. Must not be <code>null</code>.<DD><CODE>value</CODE> - The string to be scanned for property references. May be <code>null</code>. <DT><B>Returns:</B><DD>the original string with the properties replaced, or <code>null</code> if the original string is <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening <code>${</code> without a closing <code>}</code><DT><B>Since:</B></DT> <DD>1.5</DD> </DL> </DD> </DL> <HR> <A NAME="replaceProperties(org.apache.tools.ant.Project, java.lang.String, java.util.Hashtable)"><!-- --></A><H3> replaceProperties</H3> <PRE> public static java.lang.String <B>replaceProperties</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project, java.lang.String value, java.util.Hashtable keys) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>since 1.6.x. Use PropertyHelper.</I> <P> <DD>Replaces <code>${xxx}</code> style constructions in the given value with the string value of the corresponding data types. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - The container project. This is used solely for logging purposes. Must not be <code>null</code>.<DD><CODE>value</CODE> - The string to be scanned for property references. May be <code>null</code>, in which case this method returns immediately with no effect.<DD><CODE>keys</CODE> - Mapping (String to String) of property names to their values. Must not be <code>null</code>. <DT><B>Returns:</B><DD>the original string with the properties replaced, or <code>null</code> if the original string is <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening <code>${</code> without a closing <code>}</code></DL> </DD> </DL> <HR> <A NAME="parsePropertyString(java.lang.String, java.util.Vector, java.util.Vector)"><!-- --></A><H3> parsePropertyString</H3> <PRE> public static void <B>parsePropertyString</B>(java.lang.String value, java.util.Vector fragments, java.util.Vector propertyRefs) throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>since 1.6.x. Use PropertyHelper.</I> <P> <DD>Parses a string containing <code>${xxx}</code> style property references into two lists. The first list is a collection of text fragments, while the other is a set of string property names. <code>null</code> entries in the first list indicate a property reference from the second list. <p>As of Ant 1.8.0 this method is never invoked by any code inside of Ant itself.</p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - Text to parse. Must not be <code>null</code>.<DD><CODE>fragments</CODE> - List to add text fragments to. Must not be <code>null</code>.<DD><CODE>propertyRefs</CODE> - List to add property names to. Must not be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening <code>${</code> without a closing <code>}</code></DL> </DD> </DL> <HR> <A NAME="genComponentName(java.lang.String, java.lang.String)"><!-- --></A><H3> genComponentName</H3> <PRE> public static java.lang.String <B>genComponentName</B>(java.lang.String uri, java.lang.String name)</PRE> <DL> <DD>Map a namespaced {uri,name} to an internal string format. For BC purposes the names from the ant core uri will be mapped to "name", other names will be mapped to uri + ":" + name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - The namepace URI<DD><CODE>name</CODE> - The localname <DT><B>Returns:</B><DD>The stringified form of the ns name</DL> </DD> </DL> <HR> <A NAME="extractUriFromComponentName(java.lang.String)"><!-- --></A><H3> extractUriFromComponentName</H3> <PRE> public static java.lang.String <B>extractUriFromComponentName</B>(java.lang.String componentName)</PRE> <DL> <DD>extract a uri from a component name <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>componentName</CODE> - The stringified form for {uri, name} <DT><B>Returns:</B><DD>The uri or "" if not present</DL> </DD> </DL> <HR> <A NAME="extractNameFromComponentName(java.lang.String)"><!-- --></A><H3> extractNameFromComponentName</H3> <PRE> public static java.lang.String <B>extractNameFromComponentName</B>(java.lang.String componentName)</PRE> <DL> <DD>extract the element name from a component name <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>componentName</CODE> - The stringified form for {uri, name} <DT><B>Returns:</B><DD>The element name of the component</DL> </DD> </DL> <HR> <A NAME="addLocationToBuildException(org.apache.tools.ant.BuildException, org.apache.tools.ant.Location)"><!-- --></A><H3> addLocationToBuildException</H3> <PRE> public static <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> <B>addLocationToBuildException</B>(<A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> ex, <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> newLocation)</PRE> <DL> <DD>Add location to build exception. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>ex</CODE> - the build exception, if the build exception does not include<DD><CODE>newLocation</CODE> - the location of the calling task (may be null) <DT><B>Returns:</B><DD>a new build exception based in the build exception with location set to newLocation. If the original exception did not have a location, just return the build exception</DL> </DD> </DL> <HR> <A NAME="canParseAntlibDescriptor(org.apache.tools.ant.types.Resource)"><!-- --></A><H3> canParseAntlibDescriptor</H3> <PRE> public boolean <B>canParseAntlibDescriptor</B>(<A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> r)</PRE> <DL> <DD>Whether this instance of ProjectHelper can parse an Antlib descriptor given by the URL and return its content as an UnknownElement ready to be turned into an Antlib task. <p>This method should not try to parse the content of the descriptor, the URL is only given as an argument to allow subclasses to decide whether they can support a given URL scheme or not.</p> <p>Subclasses that return true in this method must also override <A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parseAntlibDescriptor(org.apache.tools.ant.Project, org.apache.tools.ant.types.Resource)"><CODE>parseAntlibDescriptor</CODE></A>.</p> <p>This implementation returns false.</p> <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="parseAntlibDescriptor(org.apache.tools.ant.Project, org.apache.tools.ant.types.Resource)"><!-- --></A><H3> parseAntlibDescriptor</H3> <PRE> public <A HREF="../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant">UnknownElement</A> <B>parseAntlibDescriptor</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> containingProject, <A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> source)</PRE> <DL> <DD>Parse the given URL as an antlib descriptor and return the content as something that can be turned into an Antlib task. <P> <DD><DL> <DT><B>Since:</B></DT> <DD>ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="canParseBuildFile(org.apache.tools.ant.types.Resource)"><!-- --></A><H3> canParseBuildFile</H3> <PRE> public boolean <B>canParseBuildFile</B>(<A HREF="../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> buildFile)</PRE> <DL> <DD>Check if the helper supports the kind of file. Some basic check on the extension's file should be done here. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>buildFile</CODE> - the file expected to be parsed (never <code>null</code>) <DT><B>Returns:</B><DD>true if the helper supports it<DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="getDefaultBuildFile()"><!-- --></A><H3> getDefaultBuildFile</H3> <PRE> public java.lang.String <B>getDefaultBuildFile</B>()</PRE> <DL> <DD>The file name of the build script to be parsed if none specified on the command line <P> <DD><DL> <DT><B>Returns:</B><DD>the name of the default file (never <code>null</code>)<DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/tools/ant/ProjectHelperRepository.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/tools/ant/ProjectHelper.html" target="_top"><B>FRAMES</B></A> <A HREF="ProjectHelper.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de