| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/ConsumerException.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>ConsumerException</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="ConsumerException";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/ConsumerException.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/ConsumerEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface 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/ConsumerException.html" target="_top">Frames</a></li>
<li><a href="ConsumerException.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.opensolaris.os.dtrace</div>
<h2 title="Class ConsumerException" class="title">Class ConsumerException</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>org.opensolaris.os.dtrace.ConsumerException</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ConsumerException</span>
extends java.lang.Exception</pre>
<div class="block">Exception thrown by a <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a> to terminate a running
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.ConsumerException">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="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/ConsumerException.html#ConsumerException-java.lang.String-">ConsumerException</a></span>(java.lang.String message)</code>
<div class="block">Creates a consumer exception with the given message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ConsumerException.html#ConsumerException-java.lang.String-java.lang.Object-">ConsumerException</a></span>(java.lang.String message,
java.lang.Object notification)</code>
<div class="block">Creates an exception thrown by a <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a>
implementation to terminate a running <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>, usually
in response to a drop or an error reported by the native DTrace
library.</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>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ConsumerException.html#getNotificationObject--">getNotificationObject</a></span>()</code>
<div class="block">Gets the optional object from the <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a> that
communicates to the <a href="../../../../org/opensolaris/os/dtrace/ExceptionHandler.html" title="interface in org.opensolaris.os.dtrace"><code>ExceptionHandler</code></a> why the listener
threw this exception.</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, toString</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="ConsumerException-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConsumerException</h4>
<pre>public ConsumerException(java.lang.String message)</pre>
<div class="block">Creates a consumer exception with the given message.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ConsumerException.html#ConsumerException-java.lang.String-java.lang.Object-"><code>ConsumerException(String message, Object
dtraceNotificationObject)</code></a></dd>
</dl>
</li>
</ul>
<a name="ConsumerException-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConsumerException</h4>
<pre>public ConsumerException(java.lang.String message,
java.lang.Object notification)</pre>
<div class="block">Creates an exception thrown by a <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a>
implementation to terminate a running <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>, usually
in response to a drop or an error reported by the native DTrace
library. Optionally includes the object reported by the native
DTrace library so it can be used by an <a href="../../../../org/opensolaris/os/dtrace/ExceptionHandler.html" title="interface in org.opensolaris.os.dtrace"><code>ExceptionHandler</code></a>
to display details about why the consumer terminated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - default display message explaining why the
consumer was terminated.</dd>
<dd><code>notification</code> - usually the object passed to a <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a> from DTrace that prompted this exception. The
notification could be any of the following: <ul> <li>a <a href="../../../../org/opensolaris/os/dtrace/Drop.html" title="class in org.opensolaris.os.dtrace"><code>Drop</code></a> passed to <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#dataDropped-org.opensolaris.os.dtrace.DropEvent-"><code>dataDropped()</code></a></li> <li>an <a href="../../../../org/opensolaris/os/dtrace/Error.html" title="class in org.opensolaris.os.dtrace"><code>Error</code></a> passed to <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#errorEncountered-org.opensolaris.os.dtrace.ErrorEvent-"><code>errorEncountered()</code></a></li> <li>a <a href="../../../../org/opensolaris/os/dtrace/ProcessState.html" title="class in org.opensolaris.os.dtrace"><code>ProcessState</code></a> passed to
<a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#processStateChanged-org.opensolaris.os.dtrace.ProcessEvent-"><code>processStateChanged()</code></a></li> </ul> or it could be a user-defined
object that describes anything unexpected in <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#dataReceived-org.opensolaris.os.dtrace.DataEvent-"><code>dataReceived()</code></a> or
that defines an arbitrary error threshold. An <a href="../../../../org/opensolaris/os/dtrace/ExceptionHandler.html" title="interface in org.opensolaris.os.dtrace"><code>ExceptionHandler</code></a> should be defined to handle any type of
notification object set by user code. May be <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#go-org.opensolaris.os.dtrace.ExceptionHandler-"><code>Consumer.go(ExceptionHandler h)</code></a></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="getNotificationObject--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNotificationObject</h4>
<pre>public java.lang.Object getNotificationObject()</pre>
<div class="block">Gets the optional object from the <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a> that
communicates to the <a href="../../../../org/opensolaris/os/dtrace/ExceptionHandler.html" title="interface in org.opensolaris.os.dtrace"><code>ExceptionHandler</code></a> why the listener
threw this exception. Usually this is the object from DTrace
(such as an <a href="../../../../org/opensolaris/os/dtrace/Error.html" title="class in org.opensolaris.os.dtrace"><code>Error</code></a>) that
prompted the exception, simply forwarded to the exception
handler.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an object that communicates to the <a href="../../../../org/opensolaris/os/dtrace/ExceptionHandler.html" title="interface in org.opensolaris.os.dtrace"><code>ExceptionHandler</code></a> why the <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>ConsumerListener</code></a> threw this
exception, may be <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#go-org.opensolaris.os.dtrace.ExceptionHandler-"><code>Consumer.go(ExceptionHandler h)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/ConsumerException.html#ConsumerException-java.lang.String-java.lang.Object-"><code>ConsumerException(String message,
Object dtraceNotificationObject)</code></a></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/ConsumerException.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/ConsumerEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface 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/ConsumerException.html" target="_top">Frames</a></li>
<li><a href="ConsumerException.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>