Commit e01c11f2 authored by Jonathan Mace's avatar Jonathan Mace

Update generated javadoc

parent ae56fce4
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<!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 (1.8.0_112) on Thu May 18 12:33:06 EDT 2017 -->
<title>BaggageContext</title>
<meta name="date" content="2017-05-18">
<link rel="stylesheet" type="text/css" href="../../javadoc-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="BaggageContext";
}
}
catch(err) {
}
//-->
</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="../../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/BaggageContext.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../brown/tracingplane/Baggage.html" title="class in brown.tracingplane"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../brown/tracingplane/BaggageListener.html" title="class in brown.tracingplane"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?brown/tracingplane/BaggageContext.html" target="_top">Frames</a></li>
<li><a href="BaggageContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">brown.tracingplane</div>
<h2 title="Interface BaggageContext" class="title">Interface BaggageContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../brown/tracingplane/impl/AtomContext.html" title="class in brown.tracingplane.impl">AtomContext</a>, <a href="../../brown/tracingplane/impl/BDLContext.html" title="class in brown.tracingplane.impl">BDLContext</a>, <a href="../../brown/tracingplane/impl/NestedBaggageContext.html" title="class in brown.tracingplane.impl">NestedBaggageContext</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BaggageContext</span></pre>
<div class="block"><p>
A <a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><code>BaggageContext</code></a> is an opaque context object belonging to an execution. Baggage contexts are propagated
alongside requests as they execute -- they should be passed to new threads, included with work items (e.g.,
<code>Runnable</code>, <code>Callable</code>, etc.), serialized in network headers, and so on.
</p>
<p>
<a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><code>BaggageContext</code></a> objects have no direct methods for manipulating contexts or accessing data that they carry.
This is because, in the common case, a <a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><code>BaggageContext</code></a> is typically empty, and an empty context is typically
implemented using null values.
</p>
<p>
To propagate <a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><code>BaggageContext</code></a> objects, call <a href="../../brown/tracingplane/BaggageProvider.html" title="interface in brown.tracingplane"><code>BaggageProvider</code></a> methods such as
<a href="../../brown/tracingplane/BaggageProvider.html#branch-B-"><code>BaggageProvider.branch(BaggageContext)</code></a>, <a href="../../brown/tracingplane/BaggageProvider.html#serialize-B-"><code>BaggageProvider.serialize(BaggageContext)</code></a>, etc.
</p></div>
</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="../../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/BaggageContext.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../brown/tracingplane/Baggage.html" title="class in brown.tracingplane"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../brown/tracingplane/BaggageListener.html" title="class in brown.tracingplane"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?brown/tracingplane/BaggageContext.html" target="_top">Frames</a></li>
<li><a href="BaggageContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
This diff is collapsed.
This diff is collapsed.
<!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 (1.8.0_112) on Thu May 18 12:33:06 EDT 2017 -->
<title>BaggageListener</title>
<meta name="date" content="2017-05-18">
<link rel="stylesheet" type="text/css" href="../../javadoc-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="BaggageListener";
}
}
catch(err) {
}
//-->
</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="../../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/BaggageListener.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../brown/tracingplane/BaggageListener.BranchListener.html" title="interface in brown.tracingplane"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?brown/tracingplane/BaggageListener.html" target="_top">Frames</a></li>
<li><a href="BaggageListener.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">brown.tracingplane</div>
<h2 title="Class BaggageListener" class="title">Class BaggageListener</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>brown.tracingplane.BaggageListener</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">BaggageListener</span>
extends java.lang.Object</pre>
<div class="block">A <a href="../../brown/tracingplane/BaggageListener.html" title="class in brown.tracingplane"><code>BaggageListener</code></a> is a callback handler that is invoked whenever core <a href="../../brown/tracingplane/BaggageProvider.html" title="interface in brown.tracingplane"><code>BaggageProvider</code></a> functions
(branch, merge, etc.) are invoked. Baggage Listeners are able to manipulate baggage instances before and after the
functions are called.
A <a href="../../brown/tracingplane/BaggageProvider.html" title="interface in brown.tracingplane"><code>BaggageProvider</code></a> must support adding <a href="../../brown/tracingplane/BaggageListener.html" title="class in brown.tracingplane"><code>BaggageListener</code></a>s.</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="memberSummary" 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">&nbsp;</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 interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../brown/tracingplane/BaggageListener.BranchListener.html" title="interface in brown.tracingplane">BaggageListener.BranchListener</a>&lt;<a href="../../brown/tracingplane/BaggageListener.BranchListener.html" title="type parameter in BaggageListener.BranchListener">B</a> extends <a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane">BaggageContext</a>&gt;</span></code>
<div class="block">Wraps calls to <a href="../../brown/tracingplane/BaggageProvider.html#branch-B-"><code>BaggageProvider.branch(BaggageContext)</code></a> so that the baggage instance(s) can be modified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../brown/tracingplane/BaggageListener.JoinListener.html" title="interface in brown.tracingplane">BaggageListener.JoinListener</a>&lt;<a href="../../brown/tracingplane/BaggageListener.JoinListener.html" title="type parameter in BaggageListener.JoinListener">B</a> extends <a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane">BaggageContext</a>&gt;</span></code>
<div class="block">Wraps calls to <a href="../../brown/tracingplane/BaggageProvider.html#join-B-B-"><code>BaggageProvider.join(BaggageContext, BaggageContext)</code></a> so that baggage instance(s) can be
modified.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></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="../../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/BaggageListener.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../brown/tracingplane/BaggageContext.html" title="interface in brown.tracingplane"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../brown/tracingplane/BaggageListener.BranchListener.html" title="interface in brown.tracingplane"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?brown/tracingplane/BaggageListener.html" target="_top">Frames</a></li>
<li><a href="BaggageListener.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
This diff is collapsed.
<!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 (1.8.0_112) on Thu May 18 12:33:06 EDT 2017 -->
<title>BaggageProviderFactory</title>
<meta name="date" content="2017-05-18">
<link rel="stylesheet" type="text/css" href="../../javadoc-stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>