Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/ProbeData.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>ProbeData</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="ProbeData";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ProbeData.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/Probe.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/ProbeData.html" target="_top">Frames</a></li>
<li><a href="ProbeData.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 ProbeData" class="title">Class ProbeData</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.ProbeData</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ProbeData</span>
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&gt;</pre>
<div class="block">Data generated when a DTrace probe fires, contains one record for
 every record-generating action in the probe.  (Some D actions, such
 as <code>clear()</code>, do not generate a <code>ProbeData</code> record.)  A
 <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a> gets data from DTrace by registering a <a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html" title="interface in org.opensolaris.os.dtrace"><code>listener</code></a> to get probe data whenever a probe fires:
 <pre><code>
     Consumer consumer = new LocalConsumer();
     consumer.addConsumerListener(new ConsumerAdapter() {
         public void dataReceived(DataEvent e) {
             ProbeData probeData = e.getProbeData();
             System.out.println(probeData);
         }
     });
 </code></pre>
 Getting DTrace to generate that probe data involves compiling,
 enabling, and running a D program:
 <pre><code>
     try {
         consumer.open();
         consumer.compile(program);
         consumer.enable(); // instruments code at matching probe points
         consumer.go(); // non-blocking; generates probe data in background
     } catch (DTraceException e) {
         e.printStackTrace();
     }
 </code></pre>
 Currently the <code>ProbeData</code> instance does not record a timestamp.
 If you need a timestamp, trace the built-in <code>timestamp</code>
 variable in your D program.  (See the
 <a href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlfv?a=view>
 <b>Built-in Variables</b></a> section of the <b>Variables</b> chapter of
 the <i>Solaris Dynamic Tracing Guide</i>).
 <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/Consumer.html#addConsumerListener-org.opensolaris.os.dtrace.ConsumerListener-"><code>Consumer.addConsumerListener(ConsumerListener l)</code></a>, 
<a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#dataReceived-org.opensolaris.os.dtrace.DataEvent-"><code>ConsumerListener.dataReceived(DataEvent e)</code></a>, 
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.ProbeData">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace">ProbeData.KeyField</a></span></code>
<div class="block">Enumerates the fields by which <a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace"><code>ProbeData</code></a> may be sorted
 using the <a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#getComparator-org.opensolaris.os.dtrace.ProbeData.KeyField...-"><code>getComparator()</code></a>
 convenience method.</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">&nbsp;</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/ProbeData.html#ProbeData-int-int-org.opensolaris.os.dtrace.ProbeDescription-org.opensolaris.os.dtrace.Flow-java.util.List-">ProbeData</a></span>(int&nbsp;enabledProbeID,
         int&nbsp;cpuID,
         <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>&nbsp;p,
         <a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace">Flow</a>&nbsp;f,
         java.util.List&lt;<a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>&gt;&nbsp;recordList)</code>
<div class="block">Creates a probe data instance with the given properties and list
 of records.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/ProbeData.html#compareTo-org.opensolaris.os.dtrace.ProbeData-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&nbsp;d)</code>
<div class="block">Natural ordering of probe data.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.util.Comparator&lt;<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#getComparator-org.opensolaris.os.dtrace.ProbeData.KeyField...-">getComparator</a></span>(<a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace">ProbeData.KeyField</a>...&nbsp;f)</code>
<div class="block">Convenience method, gets a comparator that sorts multiple <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace"><code>ProbeDescription</code></a> instances by the specified field or fields.</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/ProbeData.html#getCPU--">getCPU</a></span>()</code>
<div class="block">Gets the ID of the CPU on which the probe fired.</div>
</td>
</tr>
<tr id="i3" 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/ProbeData.html#getEnabledProbeDescription--">getEnabledProbeDescription</a></span>()</code>
<div class="block">Gets the enabled probe description.</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/ProbeData.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><a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace">Flow</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#getFlow--">getFlow</a></span>()</code>
<div class="block">Gets the current state of control flow (function entry or return,
 and depth in call stack) at the time of the probe firing that
 generated this <code>ProbeData</code> instance, or <code>null</code> if
 such information was not requested with the <code>flowindent</code>
 option.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#getRecords--">getRecords</a></span>()</code>
<div class="block">Gets the records generated by the actions of the probe that
 fired, in the same order as the actions that generated the
 records.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this <code>ProbeData</code> instance
 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&nbsp;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="ProbeData-int-int-org.opensolaris.os.dtrace.ProbeDescription-org.opensolaris.os.dtrace.Flow-java.util.List-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProbeData</h4>
<pre>public&nbsp;ProbeData(int&nbsp;enabledProbeID,
                 int&nbsp;cpuID,
                 <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>&nbsp;p,
                 <a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace">Flow</a>&nbsp;f,
                 java.util.List&lt;<a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>&gt;&nbsp;recordList)</pre>
<div class="block">Creates a probe data instance with the given properties and list
 of records.  Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabledProbeID</code> - identifies the enabled probe that fired;
 the ID is generated by the native DTrace library to distinguish
 all probes enabled by the source consumer (as opposed to
 all probes on the system)</dd>
<dd><code>cpuID</code> - non-negative ID, identifies the CPU on which the
 probe fired</dd>
<dd><code>p</code> - identifies the enabled probe that fired</dd>
<dd><code>f</code> - current state of control flow (entry or return and depth
 in call stack) at time of probe firing, included if <a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>flowindent</code></a> option used, <code>null</code> otherwise</dd>
<dd><code>recordList</code> - list of records generated by D actions in the
 probe that fired, one record per action, may be empty</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given probe description or
 list of records 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="getComparator-org.opensolaris.os.dtrace.ProbeData.KeyField...-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComparator</h4>
<pre>public static&nbsp;java.util.Comparator&lt;<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&gt;&nbsp;getComparator(<a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace">ProbeData.KeyField</a>...&nbsp;f)</pre>
<div class="block">Convenience method, gets a comparator that sorts multiple <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace"><code>ProbeDescription</code></a> instances by the specified field or fields.  If
 more than one sort field is specified, the probe data are sorted
 by the first field, and in case of a tie, by the second field,
 and so on, in the order that the fields are specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>f</code> - field specifiers given in descending order of sort
 priority; lower priority fields are only compared (as a tie
 breaker) when all higher priority fields are equal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null probe data comparator that sorts by the
 specified sort fields in the given order</dd>
</dl>
</li>
</ul>
<a name="getEnabledProbeID--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnabledProbeID</h4>
<pre>public&nbsp;int&nbsp;getEnabledProbeID()</pre>
<div class="block">Gets the enabled probe ID.  Identifies the enabled probe that
 fired and generated this <code>ProbeData</code>.  The "epid" is
 different from <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getID--"><code>ProbeDescription.getID()</code></a> in that it
 identifies a probe among all probes enabled by the source <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 generated by the native DTrace
 library</dd>
</dl>
</li>
</ul>
<a name="getCPU--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCPU</h4>
<pre>public&nbsp;int&nbsp;getCPU()</pre>
<div class="block">Gets the ID of the CPU on which the probe fired.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the CPU on which the probe fired</dd>
</dl>
</li>
</ul>
<a name="getEnabledProbeDescription--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnabledProbeDescription</h4>
<pre>public&nbsp;<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>&nbsp;getEnabledProbeDescription()</pre>
<div class="block">Gets the enabled probe description.  Identifies the enabled probe
 that fired and generated this <code>ProbeData</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null probe description</dd>
</dl>
</li>
</ul>
<a name="getFlow--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlow</h4>
<pre>public&nbsp;<a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace">Flow</a>&nbsp;getFlow()</pre>
<div class="block">Gets the current state of control flow (function entry or return,
 and depth in call stack) at the time of the probe firing that
 generated this <code>ProbeData</code> instance, or <code>null</code> if
 such information was not requested with the <code>flowindent</code>
 option.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a description of control flow across function boundaries,
 or <code>null</code> if <code>Consumer.getOption(Option.flowindent)</code>
 returns <a href="../../../../org/opensolaris/os/dtrace/Option.html#UNSET"><code>Option.UNSET</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-"><code>Consumer.setOption(String option)</code></a>, 
<a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>Option.flowindent</code></a></dd>
</dl>
</li>
</ul>
<a name="getRecords--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecords</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>&gt;&nbsp;getRecords()</pre>
<div class="block">Gets the records generated by the actions of the probe that
 fired, in the same order as the actions that generated the
 records.  The returned list includes one record for every
 record-generating D action (some D actions, such as <code>clear()</code>, do not generate records).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null, unmodifiable list view of the records belonging
 to this <code>ProbeData</code> in the order of the actions in the
 DTrace probe that generated them (record-producing actions are
 generally those that produce output, such as <code>printf()</code>,
 but also the <code>exit()</code> action)</dd>
</dl>
</li>
</ul>
<a name="compareTo-org.opensolaris.os.dtrace.ProbeData-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&nbsp;d)</pre>
<div class="block">Natural ordering of probe data.  Sorts probe data by records
 first, then if record data is equal, by enabled probe ID.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace">ProbeData</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - probe data to be compared with this probe data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a negative number, zero, or a positive number as this
 probe data is less than, equal to, or greater than the given
 probe data</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given probe data is
 <code>null</code></dd>
<dd><code>java.lang.ClassCastException</code> - if record lists of both <code>ProbeData</code> instances are not mutually comparable because
 corresponding list elements are not comparable or the lists
 themselves are different lengths</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ProbeData.html#getComparator-org.opensolaris.os.dtrace.ProbeData.KeyField...-"><code>getComparator(KeyField[] f)</code></a></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Gets a string representation of this <code>ProbeData</code> instance
 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>&nbsp;in class&nbsp;<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/ProbeData.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/Probe.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/ProbeData.html" target="_top">Frames</a></li>
<li><a href="ProbeData.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>