http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serde.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serde.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serde.html deleted file mode 100644 index dfbb9c1..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serde.html +++ /dev/null @@ -1,193 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>Serde (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="Serde (samza-api 0.8.0-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="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/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Serde.html" target="_top">Frames</a></li> -<li><a href="Serde.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li>Method</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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">org.apache.samza.serializers</div> -<h2 title="Interface Serde" class="title">Interface Serde<T></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can both read and write</dd></dl> -<dl> -<dt>All Superinterfaces:</dt> -<dd><a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T>, <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">Serde<T></span> -extends <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T>, <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T></pre> -<div class="block">A Serde is a convenience type that implements both the <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><code>Serializer</code></a> and - <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><code>Deserializer</code></a> interfaces, allowing it to both read and write data - in its value type, T.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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_org.apache.samza.serializers.Serializer"> -<!-- --> -</a> -<h3>Methods inherited from interface org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a></h3> -<code><a href="../../../../org/apache/samza/serializers/Serializer.html#toBytes(T)">toBytes</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.serializers.Deserializer"> -<!-- --> -</a> -<h3>Methods inherited from interface org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a></h3> -<code><a href="../../../../org/apache/samza/serializers/Deserializer.html#fromBytes(byte[])">fromBytes</a></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><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="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/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Serde.html" target="_top">Frames</a></li> -<li><a href="Serde.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li>Method</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li>Method</li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/SerdeFactory.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/SerdeFactory.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/SerdeFactory.html deleted file mode 100644 index 5c6fb6e..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/SerdeFactory.html +++ /dev/null @@ -1,208 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>SerdeFactory (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="SerdeFactory (samza-api 0.8.0-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="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/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/SerdeFactory.html" target="_top">Frames</a></li> -<li><a href="SerdeFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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.samza.serializers</div> -<h2 title="Interface SerdeFactory" class="title">Interface SerdeFactory<T></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object this factory's output can both read and write</dd></dl> -<hr> -<br> -<pre>public interface <span class="strong">SerdeFactory<T></span></pre> -<div class="block">Build an instance of <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><code>Serde</code></a></div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="type parameter in SerdeFactory">T</a>></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/serializers/SerdeFactory.html#getSerde(java.lang.String,%20org.apache.samza.config.Config)">getSerde</a></strong>(java.lang.String name, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getSerde(java.lang.String, org.apache.samza.config.Config)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getSerde</h4> -<pre><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="type parameter in SerdeFactory">T</a>> getSerde(java.lang.String name, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> -</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="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/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/SerdeFactory.html" target="_top">Frames</a></li> -<li><a href="SerdeFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serializer.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serializer.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serializer.html deleted file mode 100644 index 0ace0b4..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Serializer.html +++ /dev/null @@ -1,217 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>Serializer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="Serializer (samza-api 0.8.0-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="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/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Serializer.html" target="_top">Frames</a></li> -<li><a href="Serializer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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.samza.serializers</div> -<h2 title="Interface Serializer" class="title">Interface Serializer<T></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can write</dd></dl> -<dl> -<dt>All Known Subinterfaces:</dt> -<dd><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">Serializer<T></span></pre> -<div class="block">A standard interface for Samza compatible serializers, used for serializing objects to bytes.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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>byte[]</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/serializers/Serializer.html#toBytes(T)">toBytes</a></strong>(<a href="../../../../org/apache/samza/serializers/Serializer.html" title="type parameter in Serializer">T</a> object)</code> -<div class="block">Serializes given object to an array of bytes.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="toBytes(java.lang.Object)"> -<!-- --> -</a><a name="toBytes(T)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toBytes</h4> -<pre>byte[] toBytes(<a href="../../../../org/apache/samza/serializers/Serializer.html" title="type parameter in Serializer">T</a> object)</pre> -<div class="block">Serializes given object to an array of bytes.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - Object of specific type to serialize.</dd> -<dt><span class="strong">Returns:</span></dt><dd>An array of bytes representing the object in serialized form.</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="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/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Serializer.html" target="_top">Frames</a></li> -<li><a href="Serializer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-frame.html deleted file mode 100644 index d84bb9f..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-frame.html +++ /dev/null @@ -1,22 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<h1 class="bar"><a href="../../../../org/apache/samza/serializers/package-summary.html" target="classFrame">org.apache.samza.serializers</a></h1> -<div class="indexContainer"> -<h2 title="Interfaces">Interfaces</h2> -<ul title="Interfaces"> -<li><a href="Deserializer.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Deserializer</i></a></li> -<li><a href="Serde.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Serde</i></a></li> -<li><a href="SerdeFactory.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>SerdeFactory</i></a></li> -<li><a href="Serializer.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Serializer</i></a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-summary.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-summary.html deleted file mode 100644 index fb8ebcf..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-summary.html +++ /dev/null @@ -1,154 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="org.apache.samza.serializers (samza-api 0.8.0-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 class="navBarCell1Rev">Package</li> -<li>Class</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/samza/metrics/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/storage/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Package" class="title">Package org.apache.samza.serializers</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> -<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Interface</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T></td> -<td class="colLast"> -<div class="block">A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their - original form.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></td> -<td class="colLast"> -<div class="block">A Serde is a convenience type that implements both the <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><code>Serializer</code></a> and - <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><code>Deserializer</code></a> interfaces, allowing it to both read and write data - in its value type, T.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers">SerdeFactory</a><T></td> -<td class="colLast"> -<div class="block">Build an instance of <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><code>Serde</code></a></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T></td> -<td class="colLast"> -<div class="block">A standard interface for Samza compatible serializers, used for serializing objects to bytes.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> -<!-- ======= 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 class="navBarCell1Rev">Package</li> -<li>Class</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/samza/metrics/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/storage/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-tree.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-tree.html deleted file mode 100644 index 1ecc20a..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/package-tree.html +++ /dev/null @@ -1,132 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.serializers Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="org.apache.samza.serializers Class Hierarchy (samza-api 0.8.0-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</li> -<li class="navBarCell1Rev">Tree</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/samza/metrics/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/storage/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">Hierarchy For Package org.apache.samza.serializers</h1> -<span class="strong">Package Hierarchies:</span> -<ul class="horizontal"> -<li><a href="../../../../overview-tree.html">All Packages</a></li> -</ul> -</div> -<div class="contentContainer"> -<h2 title="Interface Hierarchy">Interface Hierarchy</h2> -<ul> -<li type="circle">org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Deserializer</span></a><T> -<ul> -<li type="circle">org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Serde</span></a><T> (also extends org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T>)</li> -</ul> -</li> -<li type="circle">org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">SerdeFactory</span></a><T></li> -<li type="circle">org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Serializer</span></a><T> -<ul> -<li type="circle">org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Serde</span></a><T> (also extends org.apache.samza.serializers.<a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T>)</li> -</ul> -</li> -</ul> -</div> -<!-- ======= 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</li> -<li class="navBarCell1Rev">Tree</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/samza/metrics/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/storage/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngine.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngine.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngine.html deleted file mode 100644 index 7817b9b..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngine.html +++ /dev/null @@ -1,251 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>StorageEngine (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="StorageEngine (samza-api 0.8.0-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="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngine.html" target="_top">Frames</a></li> -<li><a href="StorageEngine.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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.samza.storage</div> -<h2 title="Interface StorageEngine" class="title">Interface StorageEngine</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">StorageEngine</span></pre> -<div class="block">A storage engine for managing state maintained by a stream processor. - - <p> - This interface does not specify any query capabilities, which, of course, - would be query engine specific. Instead it just specifies the minimum - functionality required to reload a storage engine from its changelog as well - as basic lifecycle management. - </p></div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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/samza/storage/StorageEngine.html#flush()">flush</a></strong>()</code> -<div class="block">Flush any cached messages</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngine.html#restore(java.util.Iterator)">restore</a></strong>(java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> -<div class="block">Restore the content of this StorageEngine from the changelog.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngine.html#stop()">stop</a></strong>()</code> -<div class="block">Close the storage engine</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="restore(java.util.Iterator)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>restore</h4> -<pre>void restore(java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</pre> -<div class="block">Restore the content of this StorageEngine from the changelog. Messages are - provided in one <code>Iterator</code> and not deserialized for - efficiency, allowing the implementation to optimize replay, if possible.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelopes</code> - An iterator of envelopes that the storage engine can read from to - restore its state on startup.</dd></dl> -</li> -</ul> -<a name="flush()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>flush</h4> -<pre>void flush()</pre> -<div class="block">Flush any cached messages</div> -</li> -</ul> -<a name="stop()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>stop</h4> -<pre>void stop()</pre> -<div class="block">Close the storage engine</div> -</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="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngine.html" target="_top">Frames</a></li> -<li><a href="StorageEngine.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html deleted file mode 100644 index 6192f7f..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html +++ /dev/null @@ -1,225 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="StorageEngineFactory (samza-api 0.8.0-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="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/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top">Frames</a></li> -<li><a href="StorageEngineFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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.samza.storage</div> -<h2 title="Interface StorageEngineFactory" class="title">Interface StorageEngineFactory<K,V></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">StorageEngineFactory<K,V></span></pre> -<div class="block">An object provided by the storage engine implementation to create instances - of the given storage engine type.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html#getStorageEngine(java.lang.String,%20java.io.File,%20org.apache.samza.serializers.Serde,%20org.apache.samza.serializers.Serde,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.container.SamzaContainerContext)">getStorageEngine</a></strong>(java.lang.String storeName, - java.io.File storeDir, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</a>> keySerde, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</a>> msgSerde, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry, - <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> changeLogSystemStreamPartition, - <a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a> containerContext)</code> -<div class="block">Create an instance of the given storage engine.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getStorageEngine(java.lang.String, java.io.File, org.apache.samza.serializers.Serde, org.apache.samza.serializers.Serde, org.apache.samza.task.MessageCollector, org.apache.samza.metrics.MetricsRegistry, org.apache.samza.system.SystemStreamPartition, org.apache.samza.container.SamzaContainerContext)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getStorageEngine</h4> -<pre><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a> getStorageEngine(java.lang.String storeName, - java.io.File storeDir, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</a>> keySerde, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</a>> msgSerde, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry, - <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> changeLogSystemStreamPartition, - <a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a> containerContext)</pre> -<div class="block">Create an instance of the given storage engine.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storeName</code> - The name of the storage engine.</dd><dd><code>storeDir</code> - The directory of the storage engine.</dd><dd><code>keySerde</code> - The serializer to use for serializing keys when reading or writing to the store.</dd><dd><code>msgSerde</code> - The serializer to use for serializing messages when reading or writing to the store.</dd><dd><code>collector</code> - MessageCollector the storage engine uses to persist changes.</dd><dd><code>registry</code> - MetricsRegistry to which to publish storage-engine specific metrics.</dd><dd><code>changeLogSystemStreamPartition</code> - Samza stream partition from which to receive the changelog.</dd><dd><code>containerContext</code> - Information about the container in which the task is executing.</dd> -<dt><span class="strong">Returns:</span></dt><dd>The storage engine instance.</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="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/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top">Frames</a></li> -<li><a href="StorageEngineFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-frame.html deleted file mode 100644 index 184440c..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-frame.html +++ /dev/null @@ -1,20 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<h1 class="bar"><a href="../../../../org/apache/samza/storage/package-summary.html" target="classFrame">org.apache.samza.storage</a></h1> -<div class="indexContainer"> -<h2 title="Interfaces">Interfaces</h2> -<ul title="Interfaces"> -<li><a href="StorageEngine.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngine</i></a></li> -<li><a href="StorageEngineFactory.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngineFactory</i></a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-summary.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-summary.html deleted file mode 100644 index f583305..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-summary.html +++ /dev/null @@ -1,140 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="org.apache.samza.storage (samza-api 0.8.0-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 class="navBarCell1Rev">Package</li> -<li>Class</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/samza/serializers/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/system/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Package" class="title">Package org.apache.samza.storage</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> -<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Interface</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></td> -<td class="colLast"> -<div class="block">A storage engine for managing state maintained by a stream processor.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage">StorageEngineFactory</a><K,V></td> -<td class="colLast"> -<div class="block">An object provided by the storage engine implementation to create instances - of the given storage engine type.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> -<!-- ======= 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 class="navBarCell1Rev">Package</li> -<li>Class</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/samza/serializers/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/system/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-tree.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-tree.html deleted file mode 100644 index 1ed1201..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/storage/package-tree.html +++ /dev/null @@ -1,123 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-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</li> -<li class="navBarCell1Rev">Tree</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/samza/serializers/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/system/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">Hierarchy For Package org.apache.samza.storage</h1> -<span class="strong">Package Hierarchies:</span> -<ul class="horizontal"> -<li><a href="../../../../overview-tree.html">All Packages</a></li> -</ul> -</div> -<div class="contentContainer"> -<h2 title="Interface Hierarchy">Interface Hierarchy</h2> -<ul> -<li type="circle">org.apache.samza.storage.<a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">StorageEngine</span></a></li> -<li type="circle">org.apache.samza.storage.<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">StorageEngineFactory</span></a><K,V></li> -</ul> -</div> -<!-- ======= 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</li> -<li class="navBarCell1Rev">Tree</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/samza/serializers/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/system/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html deleted file mode 100644 index c963f83..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html +++ /dev/null @@ -1,357 +0,0 @@ -<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<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="IncomingMessageEnvelope (samza-api 0.8.0-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="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="IncomingMessageEnvelope.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.system</div> -<h2 title="Class IncomingMessageEnvelope" class="title">Class IncomingMessageEnvelope</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.system.IncomingMessageEnvelope</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="strong">IncomingMessageEnvelope</span> -extends java.lang.Object</pre> -<div class="block">This class represents a message envelope that is received by a StreamTask for each message that is received from a - partition of a specific input stream.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="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/samza/system/IncomingMessageEnvelope.html#IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition,%20java.lang.String,%20java.lang.Object,%20java.lang.Object)">IncomingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String offset, - java.lang.Object key, - java.lang.Object message)</code> -<div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="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/samza/system/IncomingMessageEnvelope.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getKey()">getKey</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getMessage()">getMessage</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getOffset()">getOffset</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition()">getSystemStreamPartition</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#hashCode()">hashCode</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.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.Object</h3> -<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition, java.lang.String, java.lang.Object, java.lang.Object)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>IncomingMessageEnvelope</h4> -<pre>public IncomingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String offset, - java.lang.Object key, - java.lang.Object message)</pre> -<div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The aggregate object representing the incoming stream name, the name of the cluster - from which the stream came, and the partition of the stream from which the message was received.</dd><dd><code>offset</code> - The offset in the partition that the message was received from.</dd><dd><code>key</code> - A deserialized key received from the partition offset.</dd><dd><code>message</code> - A deserialized message received from the partition offset.</dd></dl> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getSystemStreamPartition()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSystemStreamPartition</h4> -<pre>public <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> getSystemStreamPartition()</pre> -</li> -</ul> -<a name="getOffset()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getOffset</h4> -<pre>public java.lang.String getOffset()</pre> -</li> -</ul> -<a name="getKey()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getKey</h4> -<pre>public java.lang.Object getKey()</pre> -</li> -</ul> -<a name="getMessage()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMessage</h4> -<pre>public java.lang.Object getMessage()</pre> -</li> -</ul> -<a name="hashCode()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hashCode</h4> -<pre>public int hashCode()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="equals(java.lang.Object)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>equals</h4> -<pre>public boolean equals(java.lang.Object obj)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>equals</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><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="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="IncomingMessageEnvelope.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
