????
| Current Path : /opt/ant/manual/api/org/apache/tools/ant/ |
| Current File : //opt/ant/manual/api/org/apache/tools/ant/BuildException.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:50 CEST 2012 -->
<title>BuildException (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BuildException (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/tools/ant/BuildEvent.html" title="class in org.apache.tools.ant"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/tools/ant/BuildException.html" target="_top">Frames</a></li>
<li><a href="BuildException.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant</div>
<h2 title="Class BuildException" class="title">Class BuildException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.BuildException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/tools/ant/taskdefs/optional/testing/BuildTimeoutException.html" title="class in org.apache.tools.ant.taskdefs.optional.testing">BuildTimeoutException</a>, <a href="../../../../org/apache/tools/ant/ExitStatusException.html" title="class in org.apache.tools.ant">ExitStatusException</a>, <a href="../../../../org/apache/tools/ant/UnsupportedAttributeException.html" title="class in org.apache.tools.ant">UnsupportedAttributeException</a>, <a href="../../../../org/apache/tools/ant/UnsupportedElementException.html" title="class in org.apache.tools.ant">UnsupportedElementException</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">BuildException</span>
extends java.lang.RuntimeException</pre>
<div class="block">Signals an error condition during a build</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.tools.ant.BuildException">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException()">BuildException</a></strong>()</code>
<div class="block">Constructs a build exception with no descriptive information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.String)">BuildException</a></strong>(java.lang.String message)</code>
<div class="block">Constructs an exception with the given descriptive message.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.String, org.apache.tools.ant.Location)">BuildException</a></strong>(java.lang.String message,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</code>
<div class="block">Constructs an exception with the given descriptive message and a
location in a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.String, java.lang.Throwable)">BuildException</a></strong>(java.lang.String message,
java.lang.Throwable cause)</code>
<div class="block">Constructs an exception with the given message and exception as
a root cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.String, java.lang.Throwable, org.apache.tools.ant.Location)">BuildException</a></strong>(java.lang.String msg,
java.lang.Throwable cause,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</code>
<div class="block">Constructs an exception with the given message and exception as
a root cause and a location in a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.Throwable)">BuildException</a></strong>(java.lang.Throwable cause)</code>
<div class="block">Constructs an exception with the given exception as a root cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#BuildException(java.lang.Throwable, org.apache.tools.ant.Location)">BuildException</a></strong>(java.lang.Throwable cause,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</code>
<div class="block">Constructs an exception with the given exception as
a root cause and a location in a file.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Throwable</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#getException()">getException</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>Use <code>Throwable.getCause()</code> instead.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#getLocation()">getLocation</a></strong>()</code>
<div class="block">Returns the file location where the error occurred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#setLocation(org.apache.tools.ant.Location)">setLocation</a></strong>(<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</code>
<div class="block">Sets the file location where the error occurred.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/tools/ant/BuildException.html#toString()">toString</a></strong>()</code>
<div class="block">Returns the location of the error and the error message.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BuildException()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException()</pre>
<div class="block">Constructs a build exception with no descriptive information.</div>
</li>
</ul>
<a name="BuildException(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.String message)</pre>
<div class="block">Constructs an exception with the given descriptive message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - A description of or information about the exception.
Should not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="BuildException(java.lang.String, java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.String message,
java.lang.Throwable cause)</pre>
<div class="block">Constructs an exception with the given message and exception as
a root cause.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - A description of or information about the exception.
Should not be <code>null</code> unless a cause is specified.</dd><dd><code>cause</code> - The exception that might have caused this one.
May be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="BuildException(java.lang.String, java.lang.Throwable, org.apache.tools.ant.Location)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.String msg,
java.lang.Throwable cause,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</pre>
<div class="block">Constructs an exception with the given message and exception as
a root cause and a location in a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - A description of or information about the exception.
Should not be <code>null</code> unless a cause is specified.</dd><dd><code>cause</code> - The exception that might have caused this one.
May be <code>null</code>.</dd><dd><code>location</code> - The location in the project file where the error
occurred. Must not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="BuildException(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.Throwable cause)</pre>
<div class="block">Constructs an exception with the given exception as a root cause.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - The exception that might have caused this one.
Should not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="BuildException(java.lang.String, org.apache.tools.ant.Location)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.String message,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</pre>
<div class="block">Constructs an exception with the given descriptive message and a
location in a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - A description of or information about the exception.
Should not be <code>null</code>.</dd><dd><code>location</code> - The location in the project file where the error
occurred. Must not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="BuildException(java.lang.Throwable, org.apache.tools.ant.Location)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BuildException</h4>
<pre>public BuildException(java.lang.Throwable cause,
<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</pre>
<div class="block">Constructs an exception with the given exception as
a root cause and a location in a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - The exception that might have caused this one.
Should not be <code>null</code>.</dd><dd><code>location</code> - The location in the project file where the error
occurred. Must not be <code>null</code>.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getException()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getException</h4>
<pre>public java.lang.Throwable getException()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>Use <code>Throwable.getCause()</code> instead.</i></div>
<div class="block">Returns the nested exception, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the nested exception, or <code>null</code> if no
exception is associated with this one</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns the location of the error and the error message.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Throwable</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the location of the error and the error message</dd></dl>
</li>
</ul>
<a name="setLocation(org.apache.tools.ant.Location)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocation</h4>
<pre>public void setLocation(<a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> location)</pre>
<div class="block">Sets the file location where the error occurred.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The file location where the error occurred.
Must not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="getLocation()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocation</h4>
<pre>public <a href="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</a> getLocation()</pre>
<div class="block">Returns the file location where the error occurred.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the file location where the error occurred.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/tools/ant/BuildEvent.html" title="class in org.apache.tools.ant"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/tools/ant/BuildException.html" target="_top">Frames</a></li>
<li><a href="BuildException.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>