| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/PrintfRecord.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>PrintfRecord</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="PrintfRecord";
}
}
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/PrintfRecord.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/PrintaRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/Probe.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/PrintfRecord.html" target="_top">Frames</a></li>
<li><a href="PrintfRecord.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 PrintfRecord" class="title">Class PrintfRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.PrintfRecord</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/PrintfRecord.html" title="class in org.opensolaris.os.dtrace">PrintfRecord</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">PrintfRecord</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/PrintfRecord.html" title="class in org.opensolaris.os.dtrace">PrintfRecord</a>></pre>
<div class="block">A formatted string generated by the DTrace <code>printf()</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.PrintfRecord">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/PrintfRecord.html#PrintfRecord-java.util.List-java.lang.String-">PrintfRecord</a></span>(java.util.List<<a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a>> v,
java.lang.String s)</code>
<div class="block">Creates a record with the unformatted elements passed to the
DTrace <code>printf()</code> action and the resulting 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/PrintfRecord.html#compareTo-org.opensolaris.os.dtrace.PrintfRecord-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html" title="class in org.opensolaris.os.dtrace">PrintfRecord</a> r)</code>
<div class="block">Compares the formatted string value 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/PrintfRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>PrintfRecord</code> for
equality.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html#getFormattedString--">getFormattedString</a></span>()</code>
<div class="block">Gets the formatted string output of the DTrace <code>printf()</code>
action.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html#getRecord-int-">getRecord</a></span>(int i)</code>
<div class="block">Gets the unformatted element passed to the DTrace <code>printf()</code> action at the given offset in the <code>printf()</code>
argument list after the format string, starting at offset zero
for the first unformatted element.</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/PrintfRecord.html#getRecordCount--">getRecordCount</a></span>()</code>
<div class="block">Gets the number of DTrace <code>printf()</code> unformatted elements
(arguments following the format string).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html#getRecords--">getRecords</a></span>()</code>
<div class="block">Gets the unfomatted elements passed to the DTrace <code>printf()</code> action after the format string.</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/PrintfRecord.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/PrintfRecord.html#toString--">toString</a></span>()</code>
<div class="block">Gets the formatted string output of the DTrace <code>printf()</code>
action.</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="PrintfRecord-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PrintfRecord</h4>
<pre>public PrintfRecord(java.util.List<<a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a>> v,
java.lang.String s)</pre>
<div class="block">Creates a record with the unformatted elements passed to the
DTrace <code>printf()</code> action and the resulting formatted
output. Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - variable number of unformatted elements passed to the
DTrace <code>printf()</code> action</dd>
<dd><code>s</code> - formatted <code>printf()</code> output</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given list or any of its
elements is <code>null</code>, or if the given formatted string 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="getFormattedString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormattedString</h4>
<pre>public java.lang.String getFormattedString()</pre>
<div class="block">Gets the formatted string output of the DTrace <code>printf()</code>
action.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null formatted string output of the DTrace <code>printf()</code> action</dd>
</dl>
</li>
</ul>
<a name="getRecords--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecords</h4>
<pre>public java.util.List<<a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a>> getRecords()</pre>
<div class="block">Gets the unfomatted elements passed to the DTrace <code>printf()</code> action after the format string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null, unmodifiable list of unformatted elements
passed to the DTrace <code>printf()</code> action that generated this
record, in the order they appear in the argument list after the
format string</dd>
</dl>
</li>
</ul>
<a name="getRecordCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordCount</h4>
<pre>public int getRecordCount()</pre>
<div class="block">Gets the number of DTrace <code>printf()</code> unformatted elements
(arguments following the format string). For example, the
following action
<pre><code>
printf("%s %d\n", "cat", 9);
</code></pre>
generates a <code>PrintfRecord</code> with a record count of two.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of unformatted elements passed to the DTrace
<code>printf()</code> action that generated this record.</dd>
</dl>
</li>
</ul>
<a name="getRecord-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecord</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/ValueRecord.html" title="interface in org.opensolaris.os.dtrace">ValueRecord</a> getRecord(int i)</pre>
<div class="block">Gets the unformatted element passed to the DTrace <code>printf()</code> action at the given offset in the <code>printf()</code>
argument list after the format string, starting at offset zero
for the first unformatted element.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null record representing the unformatted <code>printf()</code> element at the given index (using the same order that
they appear in the <code>printf()</code> argument list)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if the given index is
out of range (index < 0 || index >= getRecordCount())</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>PrintfRecord</code> for
equality. Returns <code>true</code> if and only if the specified
object is also a <code>PrintfRecord</code> and both records have the
same formatted string and underlying data elements.</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>PrintfRecord</code> and both the formatted strings <i>and</i>
the underlying data elements of both records are equal</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.PrintfRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html" title="class in org.opensolaris.os.dtrace">PrintfRecord</a> r)</pre>
<div class="block">Compares the formatted string value of this record with that of
the given record. Note that ordering <code>printf</code> records by
their string values is incompatible with <a href="../../../../org/opensolaris/os/dtrace/PrintfRecord.html#equals-java.lang.Object-"><code>equals()</code></a>, which also checks the underlying data elements 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/PrintfRecord.html" title="class in org.opensolaris.os.dtrace">PrintfRecord</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a negative number, 0, or a positive number as this
record's formatted string is lexicographically less than, equal
to, or greater than the given record's formatted string</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 formatted string output of the DTrace <code>printf()</code>
action.</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/PrintfRecord.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/PrintaRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/Probe.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/PrintfRecord.html" target="_top">Frames</a></li>
<li><a href="PrintfRecord.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>