| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/UserSymbolRecord.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>UserSymbolRecord</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="UserSymbolRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/UserSymbolRecord.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/UserStackRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.Value.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/UserSymbolRecord.html" target="_top">Frames</a></li>
<li><a href="UserSymbolRecord.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><a href="#nested.class.summary">Nested</a> | </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 UserSymbolRecord" class="title">Class UserSymbolRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.UserSymbolRecord</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/UserSymbolRecord.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord</a>>, <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>, <a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html" title="interface in org.opensolaris.os.dtrace">SymbolValueRecord</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">UserSymbolRecord</span>
extends java.lang.Object
implements <a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html" title="interface in org.opensolaris.os.dtrace">SymbolValueRecord</a>, java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord</a>></pre>
<div class="block">A value generated by the DTrace <code>umod()</code>, <code>ufunc()</code>, or
<code>usym()</code> action used to lookup the symbol associated with a
user address.
<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.UserSymbolRecord">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"> </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 </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.Value.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord.Value</a></span></code>
<div class="block">The composite value of a symbol's process ID and user address.</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/UserSymbolRecord.html#UserSymbolRecord-int-java.lang.String-long-">UserSymbolRecord</a></span>(int pid,
java.lang.String lookupValue,
long addressValue)</code>
<div class="block">Creates a <code>UserSymbolRecord</code> with the given process ID,
symbol lookup, and user address converted in probe context as a
result of the DTrace <code>umod()</code>, <code>ufunc()</code>, or <code>usym()</code> action.</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/UserSymbolRecord.html#compareTo-org.opensolaris.os.dtrace.UserSymbolRecord-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord</a> r)</code>
<div class="block">Compares this record with the given user symbol lookup and orders
by the combined value of process ID first and address second.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>UserSymbolRecord</code>
for equality.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Gets the symbol's user address.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#getProcessID--">getProcessID</a></span>()</code>
<div class="block">Gets the process ID associated with this record's symbol.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#getSymbol--">getSymbol</a></span>()</code>
<div class="block">Gets the result of the address lookup in the same form returned
by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#lookupUserFunction-int-long-"><code>Consumer.lookupUserFunction(int pid, long address)</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.Value.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord.Value</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the composite value of the symbol's process ID and address.</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/UserSymbolRecord.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</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/UserSymbolRecord.html#toString--">toString</a></span>()</code>
<div class="block">Gets the result of this symbol lookup.</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="UserSymbolRecord-int-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UserSymbolRecord</h4>
<pre>public UserSymbolRecord(int pid,
java.lang.String lookupValue,
long addressValue)</pre>
<div class="block">Creates a <code>UserSymbolRecord</code> with the given process ID,
symbol lookup, and user address converted in probe context as a
result of the DTrace <code>umod()</code>, <code>ufunc()</code>, or <code>usym()</code> action.
<p>
Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - non-negative user process ID</dd>
<dd><code>lookupValue</code> - the result in the native DTrace library of
looking up the symbol associated with the given user address</dd>
<dd><code>addressValue</code> - symbol address</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given lookup value 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="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 symbol.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative pid</dd>
</dl>
</li>
</ul>
<a name="getSymbol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSymbol</h4>
<pre>public java.lang.String getSymbol()</pre>
<div class="block">Gets the result of the address lookup in the same form returned
by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#lookupUserFunction-int-long-"><code>Consumer.lookupUserFunction(int pid, long address)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html#getSymbol--">getSymbol</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html" title="interface in org.opensolaris.os.dtrace">SymbolValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null address lookup in the format defined by the
native DTrace library</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 symbol's user address.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html#getAddress--">getAddress</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/SymbolValueRecord.html" title="interface in org.opensolaris.os.dtrace">SymbolValueRecord</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the symbol's user address</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.Value.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord.Value</a> getValue()</pre>
<div class="block">Gets the composite value of the symbol's process ID and address.
The value is used in <a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#equals-java.lang.Object-"><code>equals()</code></a> and
<a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#compareTo-org.opensolaris.os.dtrace.UserSymbolRecord-"><code>compareTo()</code></a> to test
equality and to determine the natural ordering of <code>UserSymbolRecord</code> instances.</div>
<dl>
<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>non-null composite value of the symbols's process ID and
address</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>UserSymbolRecord</code>
for equality. Returns <code>true</code> if and only if the specified
object is also a <code>UserSymbolRecord</code> and both records have
the same process ID and the same address.</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>UserSymbolRecord</code> and both records have the same
process ID and the same address</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.UserSymbolRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord</a> r)</pre>
<div class="block">Compares this record with the given user symbol lookup and orders
by the combined value of process ID first and address second.
The comparison treats addresses as unsigned values so the
ordering is consistent with that defined in the native DTrace
library. The <code>compareTo()</code> method is compatible with <a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#equals-java.lang.Object-"><code>equals()</code></a>.</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/UserSymbolRecord.html" title="class in org.opensolaris.os.dtrace">UserSymbolRecord</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>-1, 0, or 1 as this record's combined process ID and
address is less than, equal to, or greater than the given
record's combined process ID and address</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 result of this symbol lookup. The format is defined in
the native DTrace library and is as stable as that library
definition.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.html#getSymbol--"><code>getSymbol()</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/UserSymbolRecord.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/UserStackRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/UserSymbolRecord.Value.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/UserSymbolRecord.html" target="_top">Frames</a></li>
<li><a href="UserSymbolRecord.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><a href="#nested.class.summary">Nested</a> | </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>