| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/Aggregate.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>Aggregate</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="Aggregate";
}
}
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/Aggregate.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>Prev Class</li>
<li><a href="../../../../org/opensolaris/os/dtrace/Aggregation.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/Aggregate.html" target="_top">Frames</a></li>
<li><a href="Aggregate.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 Aggregate" class="title">Class Aggregate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.Aggregate</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Aggregate</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A consistent snapshot of all aggregations requested by a single
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getAggregate--"><code>Consumer.getAggregate()</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.Aggregate">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/Aggregate.html#Aggregate-long-java.util.Collection-">Aggregate</a></span>(long snaptimeNanos,
java.util.Collection<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> aggregations)</code>
<div class="block">Creates an aggregate with the given snaptime and aggregations.</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>java.util.Map<java.lang.String,<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/Aggregate.html#asMap--">asMap</a></span>()</code>
<div class="block">Gets a read-only <code>Map</code> view of this aggregate.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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/Aggregate.html#getAggregation-java.lang.String-">getAggregation</a></span>(java.lang.String name)</code>
<div class="block">Gets the aggregation with the given name if it exists in this
aggregate snapshot.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/Aggregate.html#getAggregations--">getAggregations</a></span>()</code>
<div class="block">Gets an unordered list of all aggregations in this aggregate
snapshot.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html" title="class in org.opensolaris.os.dtrace">AggregationRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Aggregate.html#getOrderedRecords--">getOrderedRecords</a></span>()</code>
<div class="block">Gets an ordered list of this aggregate's records sequenced by
their <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getOrdinal--"><code>ordinal</code></a> property.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html" title="class in org.opensolaris.os.dtrace">AggregationRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Aggregate.html#getRecords--">getRecords</a></span>()</code>
<div class="block">Gets an unordered list of this aggregate's records.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Aggregate.html#getSnaptime--">getSnaptime</a></span>()</code>
<div class="block">Gets the nanosecond timestamp of this aggregate snapshot.</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/Aggregate.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this aggregate snapshot 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, equals, finalize, getClass, hashCode, 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="Aggregate-long-java.util.Collection-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Aggregate</h4>
<pre>public Aggregate(long snaptimeNanos,
java.util.Collection<<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> aggregations)</pre>
<div class="block">Creates an aggregate with the given snaptime and aggregations.
Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snaptimeNanos</code> - nanosecond timestamp when this aggregate was
snapped</dd>
<dd><code>aggregations</code> - unordered collection of aggregations
belonging to this aggregate</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given collection of
aggregations is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the record ordinals of the
given aggregations are invalid</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 this aggregate snapshot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>nanosecond timestamp of this aggregate snapshot</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 an unordered list of all aggregations in this aggregate
snapshot. The list is easily sortable using <code>Collections.sort(List list, Comparator c)</code> provided any
user-defined ordering. Modifying the returned list has no effect
on this aggregate. Supports XML persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>modifiable unordered list of all aggregations in this
aggregate snapshot; list is non-null and possibly empty</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 aggregation with the given name if it exists in this
aggregate snapshot.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the desired aggregation, or empty string
to request the unnamed aggregation. In D, the unnamed
aggregation is used anytime a name does not follow the
aggregation symbol '<code>@</code>', for example:
<pre> <code> @ = count();</code></pre> as opposed to
<pre> <code> @counts = count()</code></pre> resulting in an
<code>Aggregation</code> with the name "counts".</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>null</code> if no aggregation by the given name exists
in this aggregate</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Aggregation.html#getName--"><code>Aggregation.getName()</code></a></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/AggregationRecord.html" title="class in org.opensolaris.os.dtrace">AggregationRecord</a>> getRecords()</pre>
<div class="block">Gets an unordered list of this aggregate's records. The list is
sortable using <code>Collections.sort(List list,
Comparator c)</code> with any user-defined ordering. Modifying the
returned list has no effect on this aggregate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a newly created list that copies this aggregate's records
by reference in no particular order</dd>
</dl>
</li>
</ul>
<a name="getOrderedRecords--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderedRecords</h4>
<pre>public java.util.List<<a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html" title="class in org.opensolaris.os.dtrace">AggregationRecord</a>> getOrderedRecords()</pre>
<div class="block">Gets an ordered list of this aggregate's records sequenced by
their <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getOrdinal--"><code>ordinal</code></a> property.
Note that the unordered list returned by <a href="../../../../org/opensolaris/os/dtrace/Aggregate.html#getRecords--"><code>getRecords()</code></a>
can easily be sorted by any arbitrary criteria, for example by
key ascending:
<pre><code>
List <AggregationRecord> records = aggregate.getRecords();
Collections.sort(records, new Comparator <AggregationRecord> () {
public int compare(AggregationRecord r1, AggregationRecord r2) {
return r1.getTuple().compareTo(r2.getTuple());
}
});
</code></pre>
Use <code>getOrderedRecords()</code> instead of <code>getRecords()</code>
when you want to list records as they would be ordered by <code>dtrace(1M)</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a newly created list of this aggregate's records
in the order used by the native DTrace library</dd>
</dl>
</li>
</ul>
<a name="asMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asMap</h4>
<pre>public java.util.Map<java.lang.String,<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace">Aggregation</a>> asMap()</pre>
<div class="block">Gets a read-only <code>Map</code> view of this aggregate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a read-only <code>Map</code> view of this aggregate keyed by
aggregation name</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 aggregate snapshot 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/Aggregate.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>Prev Class</li>
<li><a href="../../../../org/opensolaris/os/dtrace/Aggregation.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/Aggregate.html" target="_top">Frames</a></li>
<li><a href="Aggregate.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>