| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/KernelSymbolRecord.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>KernelSymbolRecord</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="KernelSymbolRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/KernelSymbolRecord.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/KernelStackRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.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/KernelSymbolRecord.html" target="_top">Frames</a></li>
<li><a href="KernelSymbolRecord.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 KernelSymbolRecord" class="title">Class KernelSymbolRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.KernelSymbolRecord</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/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace">KernelSymbolRecord</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">KernelSymbolRecord</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/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace">KernelSymbolRecord</a>></pre>
<div class="block">A value generated by the DTrace <code>mod()</code>, <code>func()</code>, or
<code>sym()</code> action used to lookup the symbol associated with a
kernel 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.KernelSymbolRecord">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/KernelSymbolRecord.html#KernelSymbolRecord-java.lang.String-long-">KernelSymbolRecord</a></span>(java.lang.String lookupValue,
long addressValue)</code>
<div class="block">Creates a <code>KernelSymbolRecord</code> with the given symbol lookup
and kernel address converted in probe context as a result of the
DTrace <code>mod()</code>, <code>func()</code>, or <code>sym()</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/KernelSymbolRecord.html#compareTo-org.opensolaris.os.dtrace.KernelSymbolRecord-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace">KernelSymbolRecord</a> r)</code>
<div class="block">Compares this record with the given kernel symbol lookup and
orders by address.</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/KernelSymbolRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>KernelSymbolRecord</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/KernelSymbolRecord.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Gets the symbol's kernel address.</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/KernelSymbolRecord.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#lookupKernelFunction-long-"><code>Consumer.lookupKernelFunction(long address)</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the symbol's kernel address.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.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="KernelSymbolRecord-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KernelSymbolRecord</h4>
<pre>public KernelSymbolRecord(java.lang.String lookupValue,
long addressValue)</pre>
<div class="block">Creates a <code>KernelSymbolRecord</code> with the given symbol lookup
and kernel address converted in probe context as a result of the
DTrace <code>mod()</code>, <code>func()</code>, or <code>sym()</code> action.
<p>
Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>addressValue</code> - symbol address</dd>
<dd><code>lookupValue</code> - the result in the native DTrace library of
looking up the symbol associated with the given kernel 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>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<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#lookupKernelFunction-long-"><code>Consumer.lookupKernelFunction(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 kernel 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 kernel address</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Long getValue()</pre>
<div class="block">Gets the symbol's kernel address. The value is used in <a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html#equals-java.lang.Object-"><code>equals()</code></a> and <a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html#compareTo-org.opensolaris.os.dtrace.KernelSymbolRecord-"><code>compareTo()</code></a> to test equality
and to determine the natural ordering of <code>KernelSymbolRecord</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 value of the symbol's kernel 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>KernelSymbolRecord</code>
for equality. Returns <code>true</code> if and only if the specified
object is also a <code>KernelSymbolRecord</code> and both records have
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>KernelSymbolRecord</code> and both records have 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.KernelSymbolRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace">KernelSymbolRecord</a> r)</pre>
<div class="block">Compares this record with the given kernel symbol lookup and
orders by address. 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/KernelSymbolRecord.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/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace">KernelSymbolRecord</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>-1, 0, or 1 as this record's address is less than, equal
to, or greater than the given record's 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/KernelSymbolRecord.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/KernelSymbolRecord.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/KernelStackRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.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/KernelSymbolRecord.html" target="_top">Frames</a></li>
<li><a href="KernelSymbolRecord.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>