/usr/share/doc/libplexus-utils-java/api/org/codehaus/plexus/util/ExceptionUtils.html is in libplexus-utils-java-doc 1:1.5.15-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 | <!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.6.0_23) on Sat Nov 12 08:45:31 UTC 2011 -->
<TITLE>
ExceptionUtils (plexus-utils API)
</TITLE>
<META NAME="date" CONTENT="2011-11-12">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ExceptionUtils (plexus-utils API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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/codehaus/plexus/util/DirectoryWalkListener.html" title="interface in org.codehaus.plexus.util"><B>PREV CLASS</B></A>
<A HREF="../../../../org/codehaus/plexus/util/Expand.html" title="class in org.codehaus.plexus.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/util/ExceptionUtils.html" target="_top"><B>FRAMES</B></A>
<A HREF="ExceptionUtils.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.codehaus.plexus.util</FONT>
<BR>
Class ExceptionUtils</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.codehaus.plexus.util.ExceptionUtils</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ExceptionUtils</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
<p><code>ExceptionUtils</code> provides utilities for manipulating
<code>Throwable</code> objects.</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.0</DD>
<DT><B>Version:</B></DT>
<DD>$Id: ExceptionUtils.java 5958 2007-02-28 10:29:55Z olamy $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>, Dmitri Plotnikov, Stephen Colebourne</DD>
</DL>
<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>protected static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#CAUSE_METHOD_NAMES">CAUSE_METHOD_NAMES</A></B></CODE>
<BR>
The names of methods commonly used to access a wrapped
exception.</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#ExceptionUtils()">ExceptionUtils</A></B>()</CODE>
<BR>
Constructs a new <code>ExceptionUtils</code>.</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 void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#addCauseMethodName(java.lang.String)">addCauseMethodName</A></B>(java.lang.String methodName)</CODE>
<BR>
Adds to the list of method names used in the search for <code>Throwable</code>
objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getCause(java.lang.Throwable)">getCause</A></B>(java.lang.Throwable throwable)</CODE>
<BR>
Introspects the specified <code>Throwable</code> to obtain the cause.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getCause(java.lang.Throwable, java.lang.String[])">getCause</A></B>(java.lang.Throwable throwable,
java.lang.String[] methodNames)</CODE>
<BR>
Introspects the specified <code>Throwable</code> to obtain the cause
using a supplied array of method names.</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/codehaus/plexus/util/ExceptionUtils.html#getFullStackTrace(java.lang.Throwable)">getFullStackTrace</A></B>(java.lang.Throwable t)</CODE>
<BR>
A way to get the entire nested stack-trace of an throwable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getRootCause(java.lang.Throwable)">getRootCause</A></B>(java.lang.Throwable throwable)</CODE>
<BR>
Walks through the exception chain to the last element -- the
"root" of the tree -- using <A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getCause(java.lang.Throwable)"><CODE>getCause(Throwable)</CODE></A>, and
returns that exception.</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/codehaus/plexus/util/ExceptionUtils.html#getRootCauseStackTrace(java.lang.Throwable)">getRootCauseStackTrace</A></B>(java.lang.Throwable t)</CODE>
<BR>
Creates a compact stack trace for the root cause of the supplied
throwable.</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/codehaus/plexus/util/ExceptionUtils.html#getStackFrames(java.lang.Throwable)">getStackFrames</A></B>(java.lang.Throwable t)</CODE>
<BR>
Captures the stack trace associated with the specified
<code>Throwable</code> object, decomposing it into a list of
stack frames.</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/codehaus/plexus/util/ExceptionUtils.html#getStackTrace(java.lang.Throwable)">getStackTrace</A></B>(java.lang.Throwable t)</CODE>
<BR>
A convenient way of extracting the stack trace from an
exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getThrowableCount(java.lang.Throwable)">getThrowableCount</A></B>(java.lang.Throwable throwable)</CODE>
<BR>
Returns the number of <code>Throwable</code> objects in the
exception chain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Throwable[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getThrowables(java.lang.Throwable)">getThrowables</A></B>(java.lang.Throwable throwable)</CODE>
<BR>
Returns the list of <code>Throwable</code> objects in the
exception chain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#indexOfThrowable(java.lang.Throwable, java.lang.Class)">indexOfThrowable</A></B>(java.lang.Throwable throwable,
java.lang.Class type)</CODE>
<BR>
Delegates to <A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#indexOfThrowable(java.lang.Throwable, java.lang.Class, int)"><CODE>indexOfThrowable(Throwable, Class, int)</CODE></A>,
starting the search at the beginning of the exception chain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#indexOfThrowable(java.lang.Throwable, java.lang.Class, int)">indexOfThrowable</A></B>(java.lang.Throwable throwable,
java.lang.Class type,
int fromIndex)</CODE>
<BR>
Returns the (zero based) index, of the first
<code>Throwable</code> that matches the specified type in the
exception chain of <code>Throwable</code> objects with an index
greater than or equal to the specified index, or
<code>-1</code> if the type is not found.</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/codehaus/plexus/util/ExceptionUtils.html#isNestedThrowable(java.lang.Throwable)">isNestedThrowable</A></B>(java.lang.Throwable throwable)</CODE>
<BR>
Whether an Throwable is considered nested or not.</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/codehaus/plexus/util/ExceptionUtils.html#printRootCauseStackTrace(java.lang.Throwable)">printRootCauseStackTrace</A></B>(java.lang.Throwable t)</CODE>
<BR>
Equivalent to printRootCauseStackTrace(t, System.err)</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/codehaus/plexus/util/ExceptionUtils.html#printRootCauseStackTrace(java.lang.Throwable, java.io.PrintStream)">printRootCauseStackTrace</A></B>(java.lang.Throwable t,
java.io.PrintStream stream)</CODE>
<BR>
Prints a compact stack trace for the root cause of a throwable.</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/codehaus/plexus/util/ExceptionUtils.html#printRootCauseStackTrace(java.lang.Throwable, java.io.PrintWriter)">printRootCauseStackTrace</A></B>(java.lang.Throwable t,
java.io.PrintWriter writer)</CODE>
<BR>
Same as printRootCauseStackTrace(t, stream), except it takes
a PrintWriter as an argument.</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="CAUSE_METHOD_NAMES"><!-- --></A><H3>
CAUSE_METHOD_NAMES</H3>
<PRE>
protected static java.lang.String[] <B>CAUSE_METHOD_NAMES</B></PRE>
<DL>
<DD>The names of methods commonly used to access a wrapped
exception.
<P>
<DL>
</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="ExceptionUtils()"><!-- --></A><H3>
ExceptionUtils</H3>
<PRE>
protected <B>ExceptionUtils</B>()</PRE>
<DL>
<DD>Constructs a new <code>ExceptionUtils</code>. Protected to
discourage instantiation.
<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="addCauseMethodName(java.lang.String)"><!-- --></A><H3>
addCauseMethodName</H3>
<PRE>
public static void <B>addCauseMethodName</B>(java.lang.String methodName)</PRE>
<DL>
<DD><p>Adds to the list of method names used in the search for <code>Throwable</code>
objects.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>methodName</CODE> - the methodName to add to the list, null and empty strings are ignored</DL>
</DD>
</DL>
<HR>
<A NAME="getCause(java.lang.Throwable)"><!-- --></A><H3>
getCause</H3>
<PRE>
public static java.lang.Throwable <B>getCause</B>(java.lang.Throwable throwable)</PRE>
<DL>
<DD><p>Introspects the specified <code>Throwable</code> to obtain the cause.</p>
<p>The method searches for methods with specific names that return a
<code>Throwable</code> object. This will pick up most wrapping exceptions,
including those from JDK 1.4, and
The method names can be added to using <A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#addCauseMethodName(java.lang.String)"><CODE>addCauseMethodName(String)</CODE></A>.
The default list searched for are:</p>
<ul>
<li><code>getCause()</code>
<li><code>getNextException()</code>
<li><code>getTargetException()</code>
<li><code>getException()</code>
<li><code>getSourceException()</code>
<li><code>getRootCause()</code>
<li><code>getCausedByException()</code>
<li><code>getNested()</code>
</ul>
<p>In the absence of any such method, the object is inspected for a
<code>detail</code> field assignable to a <code>Throwable</code>.</p>
<p>If none of the above is found, returns <code>null</code>.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - The exception to introspect for a cause.
<DT><B>Returns:</B><DD>The cause of the <code>Throwable</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if the throwable is null</DL>
</DD>
</DL>
<HR>
<A NAME="getCause(java.lang.Throwable, java.lang.String[])"><!-- --></A><H3>
getCause</H3>
<PRE>
public static java.lang.Throwable <B>getCause</B>(java.lang.Throwable throwable,
java.lang.String[] methodNames)</PRE>
<DL>
<DD><p>Introspects the specified <code>Throwable</code> to obtain the cause
using a supplied array of method names.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - The exception to introspect for a cause.
<DT><B>Returns:</B><DD>The cause of the <code>Throwable</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if the method names array is null or contains null
<DD><CODE>java.lang.NullPointerException</CODE> - if the throwable is null</DL>
</DD>
</DL>
<HR>
<A NAME="getRootCause(java.lang.Throwable)"><!-- --></A><H3>
getRootCause</H3>
<PRE>
public static java.lang.Throwable <B>getRootCause</B>(java.lang.Throwable throwable)</PRE>
<DL>
<DD><p>Walks through the exception chain to the last element -- the
"root" of the tree -- using <A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#getCause(java.lang.Throwable)"><CODE>getCause(Throwable)</CODE></A>, and
returns that exception.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - the throwable to get the root cause for
<DT><B>Returns:</B><DD>The root cause of the <code>Throwable</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="getThrowableCount(java.lang.Throwable)"><!-- --></A><H3>
getThrowableCount</H3>
<PRE>
public static int <B>getThrowableCount</B>(java.lang.Throwable throwable)</PRE>
<DL>
<DD><p>Returns the number of <code>Throwable</code> objects in the
exception chain.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - the exception to inspect
<DT><B>Returns:</B><DD>The throwable count.</DL>
</DD>
</DL>
<HR>
<A NAME="getThrowables(java.lang.Throwable)"><!-- --></A><H3>
getThrowables</H3>
<PRE>
public static java.lang.Throwable[] <B>getThrowables</B>(java.lang.Throwable throwable)</PRE>
<DL>
<DD><p>Returns the list of <code>Throwable</code> objects in the
exception chain.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - the exception to inspect
<DT><B>Returns:</B><DD>The list of <code>Throwable</code> objects.</DL>
</DD>
</DL>
<HR>
<A NAME="indexOfThrowable(java.lang.Throwable, java.lang.Class)"><!-- --></A><H3>
indexOfThrowable</H3>
<PRE>
public static int <B>indexOfThrowable</B>(java.lang.Throwable throwable,
java.lang.Class type)</PRE>
<DL>
<DD><p>Delegates to <A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#indexOfThrowable(java.lang.Throwable, java.lang.Class, int)"><CODE>indexOfThrowable(Throwable, Class, int)</CODE></A>,
starting the search at the beginning of the exception chain.</p>
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/codehaus/plexus/util/ExceptionUtils.html#indexOfThrowable(java.lang.Throwable, java.lang.Class, int)"><CODE>indexOfThrowable(Throwable, Class, int)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="indexOfThrowable(java.lang.Throwable, java.lang.Class, int)"><!-- --></A><H3>
indexOfThrowable</H3>
<PRE>
public static int <B>indexOfThrowable</B>(java.lang.Throwable throwable,
java.lang.Class type,
int fromIndex)</PRE>
<DL>
<DD><p>Returns the (zero based) index, of the first
<code>Throwable</code> that matches the specified type in the
exception chain of <code>Throwable</code> objects with an index
greater than or equal to the specified index, or
<code>-1</code> if the type is not found.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - the exception to inspect<DD><CODE>type</CODE> - <code>Class</code> to look for<DD><CODE>fromIndex</CODE> - the (zero based) index of the starting
position in the chain to be searched
<DT><B>Returns:</B><DD>the first occurrence of the type in the chain, or
<code>-1</code> if the type is not found
<DT><B>Throws:</B>
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - If the <code>fromIndex</code>
argument is negative or not less than the count of
<code>Throwable</code>s in the chain.</DL>
</DD>
</DL>
<HR>
<A NAME="printRootCauseStackTrace(java.lang.Throwable, java.io.PrintStream)"><!-- --></A><H3>
printRootCauseStackTrace</H3>
<PRE>
public static void <B>printRootCauseStackTrace</B>(java.lang.Throwable t,
java.io.PrintStream stream)</PRE>
<DL>
<DD>Prints a compact stack trace for the root cause of a throwable.
The compact stack trace starts with the root cause and prints
stack frames up to the place where it was caught and wrapped.
Then it prints the wrapped exception and continues with stack frames
until the wrapper exception is caught and wrapped again, etc.
<p>
The method is equivalent to t.printStackTrace() for throwables
that don't have nested causes.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="printRootCauseStackTrace(java.lang.Throwable)"><!-- --></A><H3>
printRootCauseStackTrace</H3>
<PRE>
public static void <B>printRootCauseStackTrace</B>(java.lang.Throwable t)</PRE>
<DL>
<DD>Equivalent to printRootCauseStackTrace(t, System.err)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="printRootCauseStackTrace(java.lang.Throwable, java.io.PrintWriter)"><!-- --></A><H3>
printRootCauseStackTrace</H3>
<PRE>
public static void <B>printRootCauseStackTrace</B>(java.lang.Throwable t,
java.io.PrintWriter writer)</PRE>
<DL>
<DD>Same as printRootCauseStackTrace(t, stream), except it takes
a PrintWriter as an argument.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRootCauseStackTrace(java.lang.Throwable)"><!-- --></A><H3>
getRootCauseStackTrace</H3>
<PRE>
public static java.lang.String[] <B>getRootCauseStackTrace</B>(java.lang.Throwable t)</PRE>
<DL>
<DD>Creates a compact stack trace for the root cause of the supplied
throwable.
See <code>printRootCauseStackTrace(Throwable t, PrintStream s)</code>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getStackTrace(java.lang.Throwable)"><!-- --></A><H3>
getStackTrace</H3>
<PRE>
public static java.lang.String <B>getStackTrace</B>(java.lang.Throwable t)</PRE>
<DL>
<DD>A convenient way of extracting the stack trace from an
exception.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>t</CODE> - The <code>Throwable</code>.
<DT><B>Returns:</B><DD>The stack trace as generated by the exception's
<code>printStackTrace(PrintWriter)</code> method.</DL>
</DD>
</DL>
<HR>
<A NAME="getFullStackTrace(java.lang.Throwable)"><!-- --></A><H3>
getFullStackTrace</H3>
<PRE>
public static java.lang.String <B>getFullStackTrace</B>(java.lang.Throwable t)</PRE>
<DL>
<DD>A way to get the entire nested stack-trace of an throwable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>t</CODE> - The <code>Throwable</code>.
<DT><B>Returns:</B><DD>The nested stack trace, with the root cause first.</DL>
</DD>
</DL>
<HR>
<A NAME="isNestedThrowable(java.lang.Throwable)"><!-- --></A><H3>
isNestedThrowable</H3>
<PRE>
public static boolean <B>isNestedThrowable</B>(java.lang.Throwable throwable)</PRE>
<DL>
<DD>Whether an Throwable is considered nested or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - The <code>Throwable</code>.
<DT><B>Returns:</B><DD>boolean true/false</DL>
</DD>
</DL>
<HR>
<A NAME="getStackFrames(java.lang.Throwable)"><!-- --></A><H3>
getStackFrames</H3>
<PRE>
public static java.lang.String[] <B>getStackFrames</B>(java.lang.Throwable t)</PRE>
<DL>
<DD>Captures the stack trace associated with the specified
<code>Throwable</code> object, decomposing it into a list of
stack frames.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>t</CODE> - The <code>Throwable</code>.
<DT><B>Returns:</B><DD>An array of strings describing each stack frame.</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/codehaus/plexus/util/DirectoryWalkListener.html" title="interface in org.codehaus.plexus.util"><B>PREV CLASS</B></A>
<A HREF="../../../../org/codehaus/plexus/util/Expand.html" title="class in org.codehaus.plexus.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/util/ExceptionUtils.html" target="_top"><B>FRAMES</B></A>
<A HREF="ExceptionUtils.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>
|