| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/Error.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 -->
<title>Error</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Error";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Error.html">Use</a></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/opensolaris/os/dtrace/DTraceException.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ErrorEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/Error.html" target="_top">Frames</a></li>
<li><a href="Error.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.opensolaris.os.dtrace</div>
<h2 title="Class Error" class="title">Class Error</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.Error</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>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Error</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">An error encountered in the native DTrace library while tracing probe
data. Each of the fault name constants beginning with <code>DTRACEFLT_</code> identifies a specific fault with a name that is
guaranteed not to change across API versions.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#errorEncountered-org.opensolaris.os.dtrace.ErrorEvent-"><code>ConsumerListener.errorEncountered(ErrorEvent e)</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.Error">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_BADADDR">DTRACEFLT_BADADDR</a></span></code>
<div class="block">Invalid address.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_BADALIGN">DTRACEFLT_BADALIGN</a></span></code>
<div class="block">Invalid alignment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_DIVZERO">DTRACEFLT_DIVZERO</a></span></code>
<div class="block">Divide-by-zero.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_ILLOP">DTRACEFLT_ILLOP</a></span></code>
<div class="block">Illegal operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_KPRIV">DTRACEFLT_KPRIV</a></span></code>
<div class="block">Invalid kernel access.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_LIBRARY">DTRACEFLT_LIBRARY</a></span></code>
<div class="block">Library-level fault.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_NOSCRATCH">DTRACEFLT_NOSCRATCH</a></span></code>
<div class="block">Out of scratch space.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_TUPOFLOW">DTRACEFLT_TUPOFLOW</a></span></code>
<div class="block">Tuple stack overflow.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_UPRIV">DTRACEFLT_UPRIV</a></span></code>
<div class="block">Invalid user access.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#Error-org.opensolaris.os.dtrace.ProbeDescription-int-int-int-int-java.lang.String-long-java.lang.String-">Error</a></span>(<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> pdesc,
int enabledProbeID,
int errorCPU,
int errorAction,
int errorOffset,
java.lang.String faultName,
long faultAddress,
java.lang.String errorMessage)</code>
<div class="block">Creates a DTrace error with the given properties.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getAction--">getAction</a></span>()</code>
<div class="block">Gets the error-inducing action as the <i>nth</i> action (starting
at one) in the error-inducing probe, or zero if the error is in
the predicate rather than in an action.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Gets the address of the fault, if any.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getCPU--">getCPU</a></span>()</code>
<div class="block">Gets the CPU that encountered the error.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getDefaultMessage--">getDefaultMessage</a></span>()</code>
<div class="block">Gets the default message from the native DTrace library
preconstructed from the properties of this error.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getEnabledProbeID--">getEnabledProbeID</a></span>()</code>
<div class="block">Gets the enabled probe ID.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getFault--">getFault</a></span>()</code>
<div class="block">Gets the name identifying the specific fault.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getOffset--">getOffset</a></span>()</code>
<div class="block">Gets the error offset in compiled DTrace Intermediate Format
(DIF), or a negative number if the offset is not available.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#getProbeDescription--">getProbeDescription</a></span>()</code>
<div class="block">Gets the probe description that identifies the error-inducing
probe among all the probes on the system.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Error.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this error useful for logging and
not intended for display.</div>
</td>
</tr>
</table>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DTRACEFLT_BADADDR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_BADADDR</h4>
<pre>public static final java.lang.String DTRACEFLT_BADADDR</pre>
<div class="block">Invalid address.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_BADADDR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_BADALIGN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_BADALIGN</h4>
<pre>public static final java.lang.String DTRACEFLT_BADALIGN</pre>
<div class="block">Invalid alignment.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_BADALIGN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_ILLOP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_ILLOP</h4>
<pre>public static final java.lang.String DTRACEFLT_ILLOP</pre>
<div class="block">Illegal operation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_ILLOP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_DIVZERO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_DIVZERO</h4>
<pre>public static final java.lang.String DTRACEFLT_DIVZERO</pre>
<div class="block">Divide-by-zero.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_DIVZERO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_NOSCRATCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_NOSCRATCH</h4>
<pre>public static final java.lang.String DTRACEFLT_NOSCRATCH</pre>
<div class="block">Out of scratch space.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_NOSCRATCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_KPRIV">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_KPRIV</h4>
<pre>public static final java.lang.String DTRACEFLT_KPRIV</pre>
<div class="block">Invalid kernel access.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_KPRIV">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_UPRIV">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_UPRIV</h4>
<pre>public static final java.lang.String DTRACEFLT_UPRIV</pre>
<div class="block">Invalid user access.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_UPRIV">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_TUPOFLOW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DTRACEFLT_TUPOFLOW</h4>
<pre>public static final java.lang.String DTRACEFLT_TUPOFLOW</pre>
<div class="block">Tuple stack overflow.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_TUPOFLOW">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DTRACEFLT_LIBRARY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DTRACEFLT_LIBRARY</h4>
<pre>public static final java.lang.String DTRACEFLT_LIBRARY</pre>
<div class="block">Library-level fault.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Error.DTRACEFLT_LIBRARY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Error-org.opensolaris.os.dtrace.ProbeDescription-int-int-int-int-java.lang.String-long-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Error</h4>
<pre>public Error(<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> pdesc,
int enabledProbeID,
int errorCPU,
int errorAction,
int errorOffset,
java.lang.String faultName,
long faultAddress,
java.lang.String errorMessage)</pre>
<div class="block">Creates a DTrace error with the given properties. Supports XML
persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pdesc</code> - probe description that identifies the error-inducing
probe among all the probes on the system</dd>
<dd><code>enabledProbeID</code> - identifies the error-inducing probe among
all probes enabled by the same <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a></dd>
<dd><code>errorCPU</code> - non-negative ID of the CPU where the error was
encountered, or a negative number if the CPU is unknown</dd>
<dd><code>errorAction</code> - integer that identifies the error-inducing
action as the nth action (starting at one) in the error-inducing
probe, or zero if the error is in the predicate rather than in an
action</dd>
<dd><code>errorOffset</code> - error offset in compiled DTrace Intermediate
Format (DIF), or a negative number if the offset is not available</dd>
<dd><code>faultName</code> - name of the specific fault, or <code>null</code>
if the fault is unknown to the Java DTrace API</dd>
<dd><code>faultAddress</code> - address of fault, or -1 if address is not
applicable to the specific fault</dd>
<dd><code>errorMessage</code> - default message from the native DTrace
library preconstructed from the properties of this error</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given probe description or
default message is <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="getProbeDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProbeDescription</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> getProbeDescription()</pre>
<div class="block">Gets the probe description that identifies the error-inducing
probe among all the probes on the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null probe description</dd>
</dl>
</li>
</ul>
<a name="getEnabledProbeID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnabledProbeID</h4>
<pre>public int getEnabledProbeID()</pre>
<div class="block">Gets the enabled probe ID. The "epid" is different from <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getID--"><code>ProbeDescription.getID()</code></a> because it identifies a probe among all
the probes enabled by a <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>, rather than among all
the probes on the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enabled probe ID</dd>
</dl>
</li>
</ul>
<a name="getCPU--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCPU</h4>
<pre>public int getCPU()</pre>
<div class="block">Gets the CPU that encountered the error.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative CPU ID, or a negative number if the CPU is
unknown</dd>
</dl>
</li>
</ul>
<a name="getAction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAction</h4>
<pre>public int getAction()</pre>
<div class="block">Gets the error-inducing action as the <i>nth</i> action (starting
at one) in the error-inducing probe, or zero if the error is in
the predicate rather than in an action. Note that some actions
in a D program consist of multiple actions internally within the
DTrace library.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>zero if the error is in the probe predicate, otherwise
the <i>nth</i> action (<i>n</i> starting at one) from the start
of the probe that induced the error</dd>
</dl>
</li>
</ul>
<a name="getOffset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffset</h4>
<pre>public int getOffset()</pre>
<div class="block">Gets the error offset in compiled DTrace Intermediate Format
(DIF), or a negative number if the offset is not available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the error offset in compiled DTrace Intermediate Format
(DIF), or a negative number if the offset is not available</dd>
</dl>
</li>
</ul>
<a name="getFault--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFault</h4>
<pre>public java.lang.String getFault()</pre>
<div class="block">Gets the name identifying the specific fault. The names are
guaranteed not to change across API versions as long as the fault
cases they identify still exist.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of the specific fault or <code>null</code> if the
fault is unknown to the Java DTrace API</dd>
</dl>
</li>
</ul>
<a name="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public long getAddress()</pre>
<div class="block">Gets the address of the fault, if any.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>address of fault, or -1 if address is not applicable to
the specific fault (the fault is not one of <a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_BADADDR"><code>DTRACEFLT_BADADDR</code></a> or <a href="../../../../org/opensolaris/os/dtrace/Error.html#DTRACEFLT_BADALIGN"><code>DTRACEFLT_BADALIGN</code></a>)</dd>
</dl>
</li>
</ul>
<a name="getDefaultMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMessage</h4>
<pre>public java.lang.String getDefaultMessage()</pre>
<div class="block">Gets the default message from the native DTrace library
preconstructed from the properties of this error.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null preconstructed message</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Gets a string representation of this error useful for logging and
not intended for display. The exact details of the
representation are unspecified and subject to change, but the
following format may be regarded as typical:
<pre><code>
class-name[property1 = value1, property2 = value2]
</code></pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Error.html">Use</a></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/opensolaris/os/dtrace/DTraceException.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ErrorEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/Error.html" target="_top">Frames</a></li>
<li><a href="Error.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>