| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/UserStackRecord.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>UserStackRecord</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="UserStackRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/UserStackRecord.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/Tuple.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.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/UserStackRecord.html" target="_top">Frames</a></li>
<li><a href="UserStackRecord.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 UserStackRecord" class="title">Class UserStackRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.UserStackRecord</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<<a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a>>, <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>, <a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a>, <a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">UserStackRecord</span>
extends java.lang.Object
implements <a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a>, java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a>></pre>
<div class="block">A value generated by the DTrace <code>ustack()</code> or <code>jstack()</code>
action.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.UserStackRecord">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/UserStackRecord.html#UserStackRecord-int-org.opensolaris.os.dtrace.StackFrame:A-byte:A-">UserStackRecord</a></span>(int pid,
<a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>[] frames,
byte[] rawBytes)</code>
<div class="block">Creates a <code>UserStackRecord</code> with the given stack frames,
user process ID, and raw stack data.</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><a href="../../../../org/opensolaris/os/dtrace/KernelStackRecord.html" title="class in org.opensolaris.os.dtrace">KernelStackRecord</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#asKernelStackRecord--">asKernelStackRecord</a></span>()</code>
<div class="block">Gets a <code>KernelStackRecord</code> view of this record.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#asList--">asList</a></span>()</code>
<div class="block">Gets a read-only <code>List</code> view of this record's stack frames.</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/UserStackRecord.html#compareTo-org.opensolaris.os.dtrace.UserStackRecord-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a> r)</code>
<div class="block">Compares this record with the given <code>UserStackRecord</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>UserStackRecord</code>
for equality.</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/UserStackRecord.html#getProcessID--">getProcessID</a></span>()</code>
<div class="block">Gets the process ID associated with this record's user stack.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#getRawStackData--">getRawStackData</a></span>()</code>
<div class="block">Gets the native DTrace representation of this record's stack as
an array of raw bytes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#getStackFrames--">getStackFrames</a></span>()</code>
<div class="block">Gets a copy of this record's stack frames, or an empty array if
this record's raw stack data was not converted to human-readable
stack frames by DTrace.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the raw bytes used to represent this record's stack value in
the native DTrace library.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#toString--">toString</a></span>()</code>
<div class="block">Gets the <a href="../../../../org/opensolaris/os/dtrace/KernelStackRecord.html#toString--"><code>string
representation</code></a> of the view returned by <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#asKernelStackRecord--"><code>asKernelStackRecord()</code></a> preceded by the user process ID on its
own line.</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, finalize, getClass, 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="UserStackRecord-int-org.opensolaris.os.dtrace.StackFrame:A-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UserStackRecord</h4>
<pre>public UserStackRecord(int pid,
<a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>[] frames,
byte[] rawBytes)</pre>
<div class="block">Creates a <code>UserStackRecord</code> with the given stack frames,
user process ID, and raw stack data. Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frames</code> - array of human-readable stack frames, copied so
that later modifying the given frames array will not affect this
<code>UserStackRecord</code>; may be <code>null</code> or empty to indicate
that the raw stack data was not converted to human-readable stack
frames (see <a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getStackFrames--"><code>StackValueRecord.getStackFrames()</code></a>)</dd>
<dd><code>pid</code> - non-negative user process ID</dd>
<dd><code>rawBytes</code> - array of raw bytes used to represent this stack
value in the native DTrace library, needed to distinguish stacks
that have the same display value but are considered distinct by
DTrace; copied so that later modifying the given array will not
affect this <code>UserStackRecord</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given array of raw bytes is
<code>null</code> or if any element of the <code>frames</code> array is
<code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given process ID is
negative</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="getStackFrames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStackFrames</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>[] getStackFrames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getStackFrames--">StackValueRecord</a></code></span></div>
<div class="block">Gets a copy of this record's stack frames, or an empty array if
this record's raw stack data was not converted to human-readable
stack frames by DTrace. Raw stack data is not converted (i.e.
human-readable stack frames are omitted) whenever a <code>printa()</code> format string is specified without including the <code>%k</code> placeholder for the stack value represented by this record.
(The <code>stack()</code>, <code>ustack()</code>, and <code>jstack()</code>
actions are all usable as members of an aggregation tuple.) See
the <a
href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidli3?a=view>
<b><code>printa()</code></b></a> section of the <b>Output
Formatting</b> chapter of the <i>Solaris Dynamic Tracing
Guide</i> for details about <code>printa()</code> format strings.
Human-readable stack frames are generated by default if <code>printa()</code> is called without specifying a format string, or when
using <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getAggregate--"><code>Consumer.getAggregate()</code></a> as an alternative to <code>printa()</code>. They are also generated when <code>stack()</code>, <code>ustack()</code>, or <code>jstack()</code> is used as a stand-alone action
outside of an aggregation tuple.
<p>
The returned array is a copy and modifying it has no effect on
this record. Elements of the returned array are not <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getStackFrames--">getStackFrames</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a non-null, possibly empty array of this record's
human-readable stack frames, none of which are <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getRawStackData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawStackData</h4>
<pre>public byte[] getRawStackData()</pre>
<div class="block">Gets the native DTrace representation of this record's stack as
an array of raw bytes. The raw bytes include the process ID and
are used in <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#equals-java.lang.Object-"><code>equals()</code></a> and <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#compareTo-org.opensolaris.os.dtrace.UserStackRecord-"><code>compareTo()</code></a> to test equality and
to determine the natural ordering of user stack records.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getRawStackData--">getRawStackData</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the native DTrace library's internal representation of
this record's stack as a non-null array of bytes</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Object getValue()</pre>
<div class="block">Gets the raw bytes used to represent this record's stack value in
the native DTrace library. To get a human-readable
representation, call <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#toString--"><code>toString()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getValue--">getValue</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html#getValue--">getValue</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#getRawStackData--"><code>getRawStackData()</code></a></dd>
</dl>
</li>
</ul>
<a name="getProcessID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessID</h4>
<pre>public int getProcessID()</pre>
<div class="block">Gets the process ID associated with this record's user stack.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative pid</dd>
</dl>
</li>
</ul>
<a name="asList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asList</h4>
<pre>public java.util.List<<a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>> asList()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#asList--">StackValueRecord</a></code></span></div>
<div class="block">Gets a read-only <code>List</code> view of this record's stack frames.
The returned list implements <code>RandomAccess</code>. It
is empty if <a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getStackFrames--"><code>StackValueRecord.getStackFrames()</code></a> returns an empty array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#asList--">asList</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html" title="interface in org.opensolaris.os.dtrace">StackValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null, unmodifiable <code>List</code> view of this record's
stack frames</dd>
</dl>
</li>
</ul>
<a name="asKernelStackRecord--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asKernelStackRecord</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/KernelStackRecord.html" title="class in org.opensolaris.os.dtrace">KernelStackRecord</a> asKernelStackRecord()</pre>
<div class="block">Gets a <code>KernelStackRecord</code> view of this record.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null <code>KernelStackRecord</code> view of this record</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Compares the specified object with this <code>UserStackRecord</code>
for equality. Returns <code>true</code> if and only if the specified
object is also a <code>UserStackRecord</code> and both stacks have the
same raw stack data (including process ID).
<p>
This implementation first checks if the specified object is this
<code>UserStackRecord</code>. If so, it returns <code>true</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if and only if the specified object is also
a <code>UserStackRecord</code> and both stacks have the same raw stack
data (including process ID)</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="compareTo-org.opensolaris.os.dtrace.UserStackRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a> r)</pre>
<div class="block">Compares this record with the given <code>UserStackRecord</code>.
Compares the first unequal pair of bytes at the same index in
each record's raw stack data, or if all corresponding bytes are
equal, compares the length of each record's array of raw stack
data. Corresponding bytes are compared as unsigned values. The
<code>compareTo()</code> method is compatible with <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#equals-java.lang.Object-"><code>equals()</code></a>.
<p>
This implementation first checks if the specified object is this
<code>UserStackRecord</code>. If so, it returns <code>0</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>-1, 0, or 1 as this record's raw stack data is less than,
equal to, or greater than the given record's raw stack data</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 the <a href="../../../../org/opensolaris/os/dtrace/KernelStackRecord.html#toString--"><code>string
representation</code></a> of the view returned by <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html#asKernelStackRecord--"><code>asKernelStackRecord()</code></a> preceded by the user process ID on its
own line. The process ID is in the format <code>process ID:
pid</code> (where <i>pid</i> is a decimal integer) and is indented by
the same number of spaces as the stack frames. The exact format
is subject to change.</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/UserStackRecord.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/Tuple.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.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/UserStackRecord.html" target="_top">Frames</a></li>
<li><a href="UserStackRecord.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>