| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/StackValueRecord.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>StackValueRecord</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="StackValueRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/StackValueRecord.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/StackFrame.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/StddevValue.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/StackValueRecord.html" target="_top">Frames</a></li>
<li><a href="StackValueRecord.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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="Interface StackValueRecord" class="title">Interface StackValueRecord</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>, <a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/KernelStackRecord.html" title="class in org.opensolaris.os.dtrace">KernelStackRecord</a>, <a href="../../../../org/opensolaris/os/dtrace/UserStackRecord.html" title="class in org.opensolaris.os.dtrace">UserStackRecord</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StackValueRecord</span>
extends <a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a></pre>
<div class="block">A value generated by the DTrace <code>stack()</code>, <code>ustack()</code>, or
<code>jstack()</code> action.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.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/StackValueRecord.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="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.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="i2" 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/StackValueRecord.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="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.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>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ 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><a href="../../../../org/opensolaris/os/dtrace/StackFrame.html" title="class in org.opensolaris.os.dtrace">StackFrame</a>[] getStackFrames()</pre>
<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="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>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 are needed to distinguish
stacks that have the same string representation but are
considered distinct by DTrace. Duplicate stacks (stacks with the
same human-readable stack frames) can have distinct raw stack
data when program text is relocated.
<p>
Implementations of this interface use raw stack data to compute
<code>equals()</code> and <code>hashCode()</code>. If the stack belongs to a user
process, the raw bytes include the process ID.</div>
<dl>
<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>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.</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><a href="../../../../org/opensolaris/os/dtrace/StackValueRecord.html#getRawStackData--"><code>getRawStackData()</code></a></dd>
</dl>
</li>
</ul>
<a name="asList--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asList</h4>
<pre>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">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>getStackFrames()</code></a> returns an empty array.</div>
<dl>
<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>
</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/StackValueRecord.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/StackFrame.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/StddevValue.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/StackValueRecord.html" target="_top">Frames</a></li>
<li><a href="StackValueRecord.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>