Added: incubator/htrace/site/publish/apidocs/org/apache/htrace/core/MilliSpan.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/core/MilliSpan.html?rev=1703261&view=auto ============================================================================== --- incubator/htrace/site/publish/apidocs/org/apache/htrace/core/MilliSpan.html (added) +++ incubator/htrace/site/publish/apidocs/org/apache/htrace/core/MilliSpan.html Tue Sep 15 17:36:23 2015 @@ -0,0 +1,722 @@ +<!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 (version 1.7.0_51) on Tue Sep 15 10:34:57 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MilliSpan (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2015-09-15"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MilliSpan (Apache HTrace 4.1.0-incubating-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/MilliSpan.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/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/MilliSpan.html" target="_top">Frames</a></li> +<li><a href="MilliSpan.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><a href="#nested_class_summary">Nested</a> | </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.apache.htrace.core</div> +<h2 title="Class MilliSpan" class="title">Class MilliSpan</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.htrace.core.MilliSpan</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MilliSpan</span> +extends <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></pre> +<div class="block">A Span implementation that stores its information in milliseconds since the + epoch.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></strong></code> +<div class="block">The public interface for constructing a MilliSpan.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core">MilliSpan.MilliSpanDeserializer</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.htrace.core.Span"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></h3> +<code><a href="../../../../org/apache/htrace/core/Span.SpanSerializer.html" title="class in org.apache.htrace.core">Span.SpanSerializer</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#MilliSpan()">MilliSpan</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#addKVAnnotation(java.lang.String, java.lang.String)">addKVAnnotation</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Add a data annotation associated with this span</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#addTimelineAnnotation(java.lang.String)">addTimelineAnnotation</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> msg)</code> +<div class="block">Add a timeline annotation associated with this span</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#child(java.lang.String)">child</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> childDescription)</code> +<div class="block">Create a child span of this span with the given description</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#currentTimeMillis()">currentTimeMillis</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#fromJson(java.lang.String)">fromJson</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> json)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getAccumulatedMillis()">getAccumulatedMillis</a></strong>()</code> +<div class="block">Return the total amount of time elapsed since start was called, if running, + or difference between stop and start</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getDescription()">getDescription</a></strong>()</code> +<div class="block">Return a textual description of this span.<p/> + + Will never be null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getKVAnnotations()">getKVAnnotations</a></strong>()</code> +<div class="block">Get data associated with this span (read only)<p/> + + Will never be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getParents()">getParents</a></strong>()</code> +<div class="block">Returns the parent IDs of the span.<p/> + + The array will be empty if there are no parents.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getSpanId()">getSpanId</a></strong>()</code> +<div class="block">A pseudo-unique (random) number assigned to this span instance.<p/> + + The spanId is immutable and cannot be changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getStartTimeMillis()">getStartTimeMillis</a></strong>()</code> +<div class="block">Get the start time, in milliseconds</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getStopTimeMillis()">getStopTimeMillis</a></strong>()</code> +<div class="block">Get the stop time, in milliseconds</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getTimelineAnnotations()">getTimelineAnnotations</a></strong>()</code> +<div class="block">Get any timeline annotations (read only)<p/> + + Will never be null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#getTracerId()">getTracerId</a></strong>()</code> +<div class="block">Return a unique id for the process from which this Span originated.<p/> + + Will never be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#isRunning()">isRunning</a></strong>()</code> +<div class="block">Has the span been started and not yet stopped?</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#setParents(org.apache.htrace.core.SpanId[])">setParents</a></strong>(<a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a>[] parents)</code> +<div class="block">Set the parents of this span.<p/> + + Any existing parents will be cleared by this call.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#setTracerId(java.lang.String)">setTracerId</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tracerId)</code> +<div class="block">Set the process id of a span.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#stop()">stop</a></strong>()</code> +<div class="block">The block has completed, stop the clock</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#toJson()">toJson</a></strong>()</code> +<div class="block">Serialize to Json</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/MilliSpan.html#toString()">toString</a></strong>()</code> </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.<a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="MilliSpan()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MilliSpan</h4> +<pre>public MilliSpan()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="child(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>child</h4> +<pre>public <a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a> child(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> childDescription)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#child(java.lang.String)">Span</a></code></strong></div> +<div class="block">Create a child span of this span with the given description</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#child(java.lang.String)">child</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="stop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#stop()">Span</a></code></strong></div> +<div class="block">The block has completed, stop the clock</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#stop()">stop</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="currentTimeMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentTimeMillis</h4> +<pre>protected long currentTimeMillis()</pre> +</li> +</ul> +<a name="isRunning()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRunning</h4> +<pre>public boolean isRunning()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#isRunning()">Span</a></code></strong></div> +<div class="block">Has the span been started and not yet stopped?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#isRunning()">isRunning</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getAccumulatedMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAccumulatedMillis</h4> +<pre>public long getAccumulatedMillis()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getAccumulatedMillis()">Span</a></code></strong></div> +<div class="block">Return the total amount of time elapsed since start was called, if running, + or difference between stop and start</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getAccumulatedMillis()">getAccumulatedMillis</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#toString()">toString</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="getDescription()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getDescription()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getDescription()">Span</a></code></strong></div> +<div class="block">Return a textual description of this span.<p/> + + Will never be null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getDescription()">getDescription</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getSpanId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpanId</h4> +<pre>public <a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a> getSpanId()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getSpanId()">Span</a></code></strong></div> +<div class="block">A pseudo-unique (random) number assigned to this span instance.<p/> + + The spanId is immutable and cannot be changed. It is safe to access this + from multiple threads.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getSpanId()">getSpanId</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getParents()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParents</h4> +<pre>public <a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a>[] getParents()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getParents()">Span</a></code></strong></div> +<div class="block">Returns the parent IDs of the span.<p/> + + The array will be empty if there are no parents.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getParents()">getParents</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="setParents(org.apache.htrace.core.SpanId[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParents</h4> +<pre>public void setParents(<a href="../../../../org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a>[] parents)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#setParents(org.apache.htrace.core.SpanId[])">Span</a></code></strong></div> +<div class="block">Set the parents of this span.<p/> + + Any existing parents will be cleared by this call.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#setParents(org.apache.htrace.core.SpanId[])">setParents</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getStartTimeMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStartTimeMillis</h4> +<pre>public long getStartTimeMillis()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getStartTimeMillis()">Span</a></code></strong></div> +<div class="block">Get the start time, in milliseconds</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getStartTimeMillis()">getStartTimeMillis</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getStopTimeMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStopTimeMillis</h4> +<pre>public long getStopTimeMillis()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getStopTimeMillis()">Span</a></code></strong></div> +<div class="block">Get the stop time, in milliseconds</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getStopTimeMillis()">getStopTimeMillis</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="addKVAnnotation(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addKVAnnotation</h4> +<pre>public void addKVAnnotation(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#addKVAnnotation(java.lang.String, java.lang.String)">Span</a></code></strong></div> +<div class="block">Add a data annotation associated with this span</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#addKVAnnotation(java.lang.String, java.lang.String)">addKVAnnotation</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="addTimelineAnnotation(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTimelineAnnotation</h4> +<pre>public void addTimelineAnnotation(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> msg)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#addTimelineAnnotation(java.lang.String)">Span</a></code></strong></div> +<div class="block">Add a timeline annotation associated with this span</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#addTimelineAnnotation(java.lang.String)">addTimelineAnnotation</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getKVAnnotations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKVAnnotations</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getKVAnnotations()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getKVAnnotations()">Span</a></code></strong></div> +<div class="block">Get data associated with this span (read only)<p/> + + Will never be null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getKVAnnotations()">getKVAnnotations</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getTimelineAnnotations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimelineAnnotations</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a>> getTimelineAnnotations()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getTimelineAnnotations()">Span</a></code></strong></div> +<div class="block">Get any timeline annotations (read only)<p/> + + Will never be null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getTimelineAnnotations()">getTimelineAnnotations</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="getTracerId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTracerId</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTracerId()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#getTracerId()">Span</a></code></strong></div> +<div class="block">Return a unique id for the process from which this Span originated.<p/> + + Will never be null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#getTracerId()">getTracerId</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="setTracerId(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTracerId</h4> +<pre>public void setTracerId(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tracerId)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#setTracerId(java.lang.String)">Span</a></code></strong></div> +<div class="block">Set the process id of a span.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#setTracerId(java.lang.String)">setTracerId</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="toJson()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toJson</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toJson()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/htrace/core/Span.html#toJson()">Span</a></code></strong></div> +<div class="block">Serialize to Json</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Span.html#toJson()">toJson</a></code> in interface <code><a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></code></dd> +</dl> +</li> +</ul> +<a name="fromJson(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromJson</h4> +<pre>public static <a href="../../../../org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a> fromJson(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> json) + throws <a href="http://download.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/MilliSpan.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/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/MilliSpan.html" target="_top">Frames</a></li> +<li><a href="MilliSpan.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><a href="#nested_class_summary">Nested</a> | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
Added: incubator/htrace/site/publish/apidocs/org/apache/htrace/core/NeverSampler.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/core/NeverSampler.html?rev=1703261&view=auto ============================================================================== --- incubator/htrace/site/publish/apidocs/org/apache/htrace/core/NeverSampler.html (added) +++ incubator/htrace/site/publish/apidocs/org/apache/htrace/core/NeverSampler.html Tue Sep 15 17:36:23 2015 @@ -0,0 +1,326 @@ +<!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 (version 1.7.0_51) on Tue Sep 15 10:34:57 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>NeverSampler (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2015-09-15"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="NeverSampler (Apache HTrace 4.1.0-incubating-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/NeverSampler.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/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/NeverSampler.html" target="_top">Frames</a></li> +<li><a href="NeverSampler.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.Sampler">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.apache.htrace.core</div> +<h2 title="Class NeverSampler" class="title">Class NeverSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">org.apache.htrace.core.Sampler</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.htrace.core.NeverSampler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">NeverSampler</span> +extends <a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></pre> +<div class="block">A Sampler that never returns true.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.htrace.core.Sampler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></h3> +<code><a href="../../../../org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core">NeverSampler</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/NeverSampler.html#INSTANCE">INSTANCE</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.htrace.core.Sampler"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></h3> +<code><a href="../../../../org/apache/htrace/core/Sampler.html#ALWAYS">ALWAYS</a>, <a href="../../../../org/apache/htrace/core/Sampler.html#NEVER">NEVER</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/htrace/core/NeverSampler.html#NeverSampler(org.apache.htrace.core.HTraceConfiguration)">NeverSampler</a></strong>(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/NeverSampler.html#next()">next</a></strong>()</code> </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.<a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="INSTANCE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INSTANCE</h4> +<pre>public static final <a href="../../../../org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core">NeverSampler</a> INSTANCE</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="NeverSampler(org.apache.htrace.core.HTraceConfiguration)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NeverSampler</h4> +<pre>public NeverSampler(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public boolean next()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Sampler.html#next()">next</a></code> in class <code><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/NeverSampler.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/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/NeverSampler.html" target="_top">Frames</a></li> +<li><a href="NeverSampler.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.Sampler">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/htrace/site/publish/apidocs/org/apache/htrace/core/POJOSpanReceiver.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/core/POJOSpanReceiver.html?rev=1703261&view=auto ============================================================================== --- incubator/htrace/site/publish/apidocs/org/apache/htrace/core/POJOSpanReceiver.html (added) +++ incubator/htrace/site/publish/apidocs/org/apache/htrace/core/POJOSpanReceiver.html Tue Sep 15 17:36:23 2015 @@ -0,0 +1,329 @@ +<!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 (version 1.7.0_51) on Tue Sep 15 10:34:57 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>POJOSpanReceiver (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2015-09-15"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="POJOSpanReceiver (Apache HTrace 4.1.0-incubating-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/POJOSpanReceiver.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/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/POJOSpanReceiver.html" target="_top">Frames</a></li> +<li><a href="POJOSpanReceiver.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.SpanReceiver">Nested</a> | </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.apache.htrace.core</div> +<h2 title="Class POJOSpanReceiver" class="title">Class POJOSpanReceiver</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">org.apache.htrace.core.SpanReceiver</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.htrace.core.POJOSpanReceiver</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://download.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">POJOSpanReceiver</span> +extends <a href="../../../../org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></pre> +<div class="block">SpanReceiver for testing only that just collects the Span objects it + receives. The spans it receives can be accessed with getSpans();</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.htrace.core.SpanReceiver"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></h3> +<code><a href="../../../../org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html#POJOSpanReceiver(org.apache.htrace.core.HTraceConfiguration)">POJOSpanReceiver</a></strong>(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html#getSpans()">getSpans</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/POJOSpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan</a></strong>(<a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a> span)</code> +<div class="block">Called when a Span is stopped and can now be stored.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.htrace.core.SpanReceiver"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></h3> +<code><a href="../../../../org/apache/htrace/core/SpanReceiver.html#getId()">getId</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="POJOSpanReceiver(org.apache.htrace.core.HTraceConfiguration)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>POJOSpanReceiver</h4> +<pre>public POJOSpanReceiver(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSpans()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpans</h4> +<pre>public <a href="http://download.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a>> getSpans()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The spans this POJOSpanReceiver has received.</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws <a href="http://download.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="receiveSpan(org.apache.htrace.core.Span)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>receiveSpan</h4> +<pre>public void receiveSpan(<a href="../../../../org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a> span)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/htrace/core/SpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">SpanReceiver</a></code></strong></div> +<div class="block">Called when a Span is stopped and can now be stored.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/SpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan</a></code> in class <code><a href="../../../../org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/POJOSpanReceiver.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/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/POJOSpanReceiver.html" target="_top">Frames</a></li> +<li><a href="POJOSpanReceiver.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.SpanReceiver">Nested</a> | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/htrace/site/publish/apidocs/org/apache/htrace/core/ProbabilitySampler.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/core/ProbabilitySampler.html?rev=1703261&view=auto ============================================================================== --- incubator/htrace/site/publish/apidocs/org/apache/htrace/core/ProbabilitySampler.html (added) +++ incubator/htrace/site/publish/apidocs/org/apache/htrace/core/ProbabilitySampler.html Tue Sep 15 17:36:23 2015 @@ -0,0 +1,341 @@ +<!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 (version 1.7.0_51) on Tue Sep 15 10:34:57 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ProbabilitySampler (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2015-09-15"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProbabilitySampler (Apache HTrace 4.1.0-incubating-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProbabilitySampler.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/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/ProbabilitySampler.html" target="_top">Frames</a></li> +<li><a href="ProbabilitySampler.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.Sampler">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.apache.htrace.core</div> +<h2 title="Class ProbabilitySampler" class="title">Class ProbabilitySampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">org.apache.htrace.core.Sampler</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.htrace.core.ProbabilitySampler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ProbabilitySampler</span> +extends <a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></pre> +<div class="block">Sampler that returns true a certain percentage of the time. Specify the frequency interval by + configuring a <code>double</code> value for <a href="../../../../org/apache/htrace/core/ProbabilitySampler.html#SAMPLER_FRACTION_CONF_KEY"><code>SAMPLER_FRACTION_CONF_KEY</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.htrace.core.Sampler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></h3> +<code><a href="../../../../org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html#SAMPLER_FRACTION_CONF_KEY">SAMPLER_FRACTION_CONF_KEY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html#threshold">threshold</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.htrace.core.Sampler"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.htrace.core.<a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></h3> +<code><a href="../../../../org/apache/htrace/core/Sampler.html#ALWAYS">ALWAYS</a>, <a href="../../../../org/apache/htrace/core/Sampler.html#NEVER">NEVER</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html#ProbabilitySampler(org.apache.htrace.core.HTraceConfiguration)">ProbabilitySampler</a></strong>(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/htrace/core/ProbabilitySampler.html#next()">next</a></strong>()</code> </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.<a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="threshold"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>threshold</h4> +<pre>public final double threshold</pre> +</li> +</ul> +<a name="SAMPLER_FRACTION_CONF_KEY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SAMPLER_FRACTION_CONF_KEY</h4> +<pre>public static final <a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SAMPLER_FRACTION_CONF_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.htrace.core.ProbabilitySampler.SAMPLER_FRACTION_CONF_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ProbabilitySampler(org.apache.htrace.core.HTraceConfiguration)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProbabilitySampler</h4> +<pre>public ProbabilitySampler(<a href="../../../../org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a> conf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public boolean next()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/htrace/core/Sampler.html#next()">next</a></code> in class <code><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProbabilitySampler.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/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/htrace/core/ProbabilitySampler.html" target="_top">Frames</a></li> +<li><a href="ProbabilitySampler.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><a href="#nested_classes_inherited_from_class_org.apache.htrace.core.Sampler">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
