| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/PrintaRecord.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>PrintaRecord</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="PrintaRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/PrintaRecord.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/Option.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.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/PrintaRecord.html" target="_top">Frames</a></li>
<li><a href="PrintaRecord.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 PrintaRecord" class="title">Class PrintaRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.PrintaRecord</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/PrintaRecord.html" title="class in org.opensolaris.os.dtrace">PrintaRecord</a>>, <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">PrintaRecord</span>
extends java.lang.Object
implements <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>, java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html" title="class in org.opensolaris.os.dtrace">PrintaRecord</a>></pre>
<div class="block">A record generated by the DTrace <code>printa()</code> action. Lists the
aggregations passed to <code>printa()</code> and records the formatted
output associated with each <a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace"><code>Tuple</code></a>. If multiple aggregations
were passed to the <code>printa()</code> action that generated this
record, then the DTrace library tabulates the output, using a default
format if no format string was specified. By default, the output
string associated with a given <code>Tuple</code> includes a value from
each aggregation, or zero wherever an aggregation has no value
associated with that <code>Tuple</code>. For example, the D statements
<pre><code>
@a[123] = sum(1);
@b[456] = sum(2);
printa(@a, @b, @c);
</code></pre>
produce output for the tuples "123" and "456" similar to the
following:
<pre><code>
123 1 0 0
456 0 2 0
</code></pre>
The first column after the tuple contains values from <code>@a</code>,
the next column contains values from <code>@b</code>, and the last
column contains zeros because <code>@c</code> has neither a value
associated with "123" nor a value associated with "456".
<p>
If a format string is passed to <code>printa()</code>, it may limit the
aggregation data available in this record. For example, if the
format string specifies a value placeholder for only one of two
aggregations passed to <code>printa()</code>, then the resulting <code>PrintaRecord</code> will contain only one <code>Aggregation</code>. If no value
placeholder is specified, or if the aggregation tuple is not
completely specified, the resulting <code>PrintaRecord</code> will contain
no aggregation data. However, the formatted output generated by the
DTrace library is available in all cases. For details about
<code>printa()</code> format strings, 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>.
<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.PrintaRecord">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/PrintaRecord.html#PrintaRecord-long-java.util.Collection-java.util.Map-java.util.List-java.lang.String-">PrintaRecord</a></span>(long snaptimeNanos,
java.util.Collection<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> aggs,
java.util.Map<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>,java.lang.String> formattedOutput,
java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>> orderedTuples,
java.lang.String formattedOutputString)</code>
<div class="block">Creates a record with the given snaptime, aggregations, and
formatted output.</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/PrintaRecord.html#compareTo-org.opensolaris.os.dtrace.PrintaRecord-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html" title="class in org.opensolaris.os.dtrace">PrintaRecord</a> r)</code>
<div class="block">Compares the formatted <a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getOutput--"><code>output</code></a> of this record
with that of the given record.</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/PrintaRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>PrintaRecord</code> for
equality.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getAggregation-java.lang.String-">getAggregation</a></span>(java.lang.String name)</code>
<div class="block">Gets the named aggregation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getAggregations--">getAggregations</a></span>()</code>
<div class="block">Gets a list of the aggregations passed to the <code>printa()</code>
action that generated this record.</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/PrintaRecord.html#getFormattedString-org.opensolaris.os.dtrace.Tuple-">getFormattedString</a></span>(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> key)</code>
<div class="block">Gets the formatted string, if any, associated with the given
aggregation tuple.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>,java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getFormattedStrings--">getFormattedStrings</a></span>()</code>
<div class="block">Gets the formatted output, if any, associated with each <code>Tuple</code> occurring in the aggregations belonging to this record,
one formatted string per <code>Tuple</code>.</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/PrintaRecord.html#getOutput--">getOutput</a></span>()</code>
<div class="block">Gets this record's formatted output.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getSnaptime--">getSnaptime</a></span>()</code>
<div class="block">Gets the nanosecond timestamp of the aggregate snapshot used to
create this <code>printa()</code> record.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getTuples--">getTuples</a></span>()</code>
<div class="block">Gets an ordered list of this record's aggregation tuples.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this 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 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="PrintaRecord-long-java.util.Collection-java.util.Map-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PrintaRecord</h4>
<pre>public PrintaRecord(long snaptimeNanos,
java.util.Collection<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> aggs,
java.util.Map<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>,java.lang.String> formattedOutput,
java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>> orderedTuples,
java.lang.String formattedOutputString)</pre>
<div class="block">Creates a record with the given snaptime, aggregations, and
formatted output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snaptimeNanos</code> - nanosecond timestamp of the snapshot used
to create this <code>printa()</code> record</dd>
<dd><code>aggs</code> - aggregations passed to the <code>printa()</code> action
that generated this record</dd>
<dd><code>formattedOutput</code> - the formatted output, if any, associated
with each <code>Tuple</code> occurring in the aggregations belonging
to this record, one formatted string per <code>Tuple</code>, or an
empty or <code>null</code> map if an incomplete <code>printa()</code>
format string caused aggregation tuples to be omitted from this
record</dd>
<dd><code>orderedTuples</code> - list of aggregation tuples in the same order
generated by the native DTrace library (determined by the various
"aggsort" options such as <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>Option.aggsortkey</code></a>)</dd>
<dd><code>formattedOutputString</code> - <code>printa()</code> formatted string
output in the same order generated by the native DTrace library
(determined by the various "aggsort" options such as
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>Option.aggsortkey</code></a>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given collection of
aggregations is <code>null</code>, or if the given ordered lists of
tuples or formatted strings are <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given snaptime 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="getSnaptime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSnaptime</h4>
<pre>public long getSnaptime()</pre>
<div class="block">Gets the nanosecond timestamp of the aggregate snapshot used to
create this <code>printa()</code> record.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>nanosecond timestamp</dd>
</dl>
</li>
</ul>
<a name="getAggregation-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAggregation</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a> getAggregation(java.lang.String name)</pre>
<div class="block">Gets the named aggregation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the named aggregation passed to <code>printa()</code>, or
<code>null</code> if the named aggregation is not passed to <code>printa()</code>, or if it is omitted due to an incomplete <code>printa()</code> format string, or if it is empty (a future release of
this API may represent an empty DTrace aggregation as a non-null
<code>Aggregation</code> with no records; users of this API should not
rely on a non-null return value to indicate a non-zero record
count)</dd>
</dl>
</li>
</ul>
<a name="getAggregations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAggregations</h4>
<pre>public java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> getAggregations()</pre>
<div class="block">Gets a list of the aggregations passed to the <code>printa()</code>
action that generated this record. The returned list is a copy,
and modifying it has no effect on this record. Supports XML
persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null, possibly empty list of aggregations belonging
to this record (empty aggregations are excluded)</dd>
</dl>
</li>
</ul>
<a name="getFormattedString-org.opensolaris.os.dtrace.Tuple-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormattedString</h4>
<pre>public java.lang.String getFormattedString(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> key)</pre>
<div class="block">Gets the formatted string, if any, associated with the given
aggregation tuple.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - aggregation tuple</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the formatted string associated with the given
aggregation tuple, or <code>null</code> if the given tuple does not
exist in the aggregations belonging to this record or if it
is omitted from this record due to an incomplete <code>printa()</code>
format string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getFormattedStrings--"><code>getFormattedStrings()</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getOutput--"><code>getOutput()</code></a></dd>
</dl>
</li>
</ul>
<a name="getFormattedStrings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormattedStrings</h4>
<pre>public java.util.Map<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>,java.lang.String> getFormattedStrings()</pre>
<div class="block">Gets the formatted output, if any, associated with each <code>Tuple</code> occurring in the aggregations belonging to this record,
one formatted string per <code>Tuple</code>. Gets an empty map if
aggregation tuples are omitted from this record due to an
incomplete <code>printa()</code> format string. The returned map is a
copy and modifying it has no effect on this record. Supports XML
persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map of aggregation tuples and their associated
formatted output strings, empty if aggregation tuples are omitted
from this record due to an incomplete <code>printa(</code>) format
string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getFormattedString-org.opensolaris.os.dtrace.Tuple-"><code>getFormattedString(Tuple key)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getOutput--"><code>getOutput()</code></a></dd>
</dl>
</li>
</ul>
<a name="getTuples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTuples</h4>
<pre>public java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a>> getTuples()</pre>
<div class="block">Gets an ordered list of this record's aggregation tuples. The
returned list is a copy, and modifying it has no effect on this
record. Supports XML persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a non-null list of this record's aggregation tuples in
the order they were generated by the native DTrace library, as
determined by the <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>Option.aggsortkey</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>Option.aggsortrev</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>Option.aggsortpos</code></a>, and <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>Option.aggsortkeypos</code></a> options</dd>
</dl>
</li>
</ul>
<a name="getOutput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutput</h4>
<pre>public java.lang.String getOutput()</pre>
<div class="block">Gets this record's formatted output. Supports XML persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null formatted output in the order generated by the
native DTrace library, as determined by the <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>Option.aggsortkey</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>Option.aggsortrev</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>Option.aggsortpos</code></a>, and <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>Option.aggsortkeypos</code></a> options</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>PrintaRecord</code> for
equality. Returns <code>true</code> if and only if the specified
object is also a <code>PrintaRecord</code> and both records have the
same aggregations and the same formatted strings in the same
order (by aggregation tuple).</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>PrintaRecord</code> and both records have the same
aggregations and the same formatted strings in the same order (by
aggregation tuple)</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.PrintaRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html" title="class in org.opensolaris.os.dtrace">PrintaRecord</a> r)</pre>
<div class="block">Compares the formatted <a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#getOutput--"><code>output</code></a> of this record
with that of the given record. Note that ordering <code>printa</code>
records by their output string values is incompatible with <a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html#equals-java.lang.Object-"><code>equals()</code></a>, which also checks the underlying
aggregation data for equality.</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/PrintaRecord.html" title="class in org.opensolaris.os.dtrace">PrintaRecord</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a negative number, 0, or a positive number as this
record's formatted output is lexicographically less than, equal
to, or greater than the given record's formatted output</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 a string representation of this 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> 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/PrintaRecord.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/Option.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.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/PrintaRecord.html" target="_top">Frames</a></li>
<li><a href="PrintaRecord.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>