Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StoreProperties.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StoreProperties.html?rev=1755637&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StoreProperties.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StoreProperties.html Tue Aug 9 18:13:38 2016 @@ -0,0 +1,261 @@ +<!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_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<title>StoreProperties (samza-api 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-09"> +<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="StoreProperties (samza-api 0.10.1-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/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/storage/StoreProperties.StorePropertiesBuilder.html" title="class 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/StoreProperties.html" target="_top">Frames</a></li> +<li><a href="StoreProperties.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>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="Class StoreProperties" class="title">Class StoreProperties</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.storage.StoreProperties</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StoreProperties</span> +extends java.lang.Object</pre> +<div class="block">Immutable class that defines the properties of a Store</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StoreProperties.StorePropertiesBuilder.html" title="class in org.apache.samza.storage">StoreProperties.StorePropertiesBuilder</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StoreProperties.html#isLoggedStore()">isLoggedStore</a></strong>()</code> +<div class="block">Flag to indicate whether a store is associated with a changelog (used for recovery) or not</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StoreProperties.html#isPersistedToDisk()">isPersistedToDisk</a></strong>()</code> +<div class="block">Flag to indicate whether a store can be persisted to disk or not</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</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="isPersistedToDisk()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPersistedToDisk</h4> +<pre>public boolean isPersistedToDisk()</pre> +<div class="block">Flag to indicate whether a store can be persisted to disk or not</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True, if store can be flushed to disk. False, by default.</dd></dl> +</li> +</ul> +<a name="isLoggedStore()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isLoggedStore</h4> +<pre>public boolean isLoggedStore()</pre> +<div class="block">Flag to indicate whether a store is associated with a changelog (used for recovery) or not</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True, if changelog is enabled. False, by default.</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/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/storage/StoreProperties.StorePropertiesBuilder.html" title="class 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/StoreProperties.html" target="_top">Frames</a></li> +<li><a href="StoreProperties.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>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>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/Entry.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/Entry.html?rev=1755637&r1=1755636&r2=1755637&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/Entry.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/Entry.html Tue Aug 9 18:13:38 2016 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_77) on Wed Apr 20 11:00:53 PDT 2016 --> +<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:10 PDT 2016 --> <title>Entry (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-04-20"> +<meta name="date" content="2016-08-09"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Entry (samza-api 0.10.1-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Entry (samza-api 0.10.1-SNAPSHOT API)"; } //--> -var methods = {"i0":10,"i1":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/Entry.html" target="_top">Frames</a></li> -<li><a href="Entry.html" target="_top">No Frames</a></li> +<li><a href="Entry.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -75,17 +62,17 @@ var activeTableTab = "activeTableTab"; <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> +<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> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -106,14 +93,10 @@ var activeTableTab = "activeTableTab"; <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl> -<dt><span class="paramLabel">Type Parameters:</span></dt> -<dd><code>K</code> - The key type</dd> -<dd><code>V</code> - The value type</dd> -</dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - The key type</dd><dd><code>V</code> - The value type</dd></dl> <hr> <br> -<pre>public class <span class="typeNameLabel">Entry<K,V></span> +<pre>public class <span class="strong">Entry<K,V></span> extends java.lang.Object</pre> <div class="block">A key and value.</div> </li> @@ -124,17 +107,17 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> +<li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<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><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/Entry.html#Entry-K-V-">Entry</a></span>(<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">K</a> key, +<td class="colOne"><code><strong><a href="../../../../../org/apache/samza/storage/kv/Entry.html#Entry(K,%20V)">Entry</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">K</a> key, <a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">V</a> value)</code> </td> </tr> </table> @@ -142,27 +125,27 @@ extends java.lang.Object</pre> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">K</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/Entry.html#getKey--">getKey</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/Entry.html#getKey()">getKey</a></strong>()</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">V</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/Entry.html#getValue--">getValue</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/Entry.html#getValue()">getValue</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -178,31 +161,31 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> +<li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="Entry-java.lang.Object-java.lang.Object-"> +<a name="Entry(java.lang.Object,java.lang.Object)"> <!-- --> -</a><a name="Entry-K-V-"> +</a><a name="Entry(K, V)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Entry</h4> <pre>public Entry(<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">K</a> key, - <a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">V</a> value)</pre> + <a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">V</a> value)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getKey--"> +<a name="getKey()"> <!-- --> </a> <ul class="blockList"> @@ -211,7 +194,7 @@ extends java.lang.Object</pre> <pre>public <a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="type parameter in Entry">K</a> getKey()</pre> </li> </ul> -<a name="getValue--"> +<a name="getValue()"> <!-- --> </a> <ul class="blockListLast"> @@ -228,11 +211,9 @@ extends java.lang.Object</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -247,15 +228,15 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/Entry.html" target="_top">Frames</a></li> -<li><a href="Entry.html" target="_top">No Frames</a></li> +<li><a href="Entry.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -274,17 +255,17 @@ extends java.lang.Object</pre> <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> +<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> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueIterator.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueIterator.html?rev=1755637&r1=1755636&r2=1755637&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueIterator.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueIterator.html Tue Aug 9 18:13:38 2016 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_77) on Wed Apr 20 11:00:53 PDT 2016 --> +<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:10 PDT 2016 --> <title>KeyValueIterator (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-04-20"> +<meta name="date" content="2016-08-09"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="KeyValueIterator (samza-api 0.10.1-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KeyValueIterator (samza-api 0.10.1-SNAPSHOT API)"; } //--> -var methods = {"i0":6,"i1":6,"i2":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/KeyValueIterator.html" target="_top">Frames</a></li> -<li><a href="KeyValueIterator.html" target="_top">No Frames</a></li> +<li><a href="KeyValueIterator.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -104,7 +91,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public interface <span class="typeNameLabel">KeyValueIterator<K,V></span> +<pre>public interface <span class="strong">KeyValueIterator<K,V></span> extends java.util.Iterator<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><K,V>></pre> </li> </ul> @@ -114,35 +101,27 @@ extends java.util.Iterator<<a href=". <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html#close--">close</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html#seek-K-">seek</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="type parameter in KeyValueIterator">K</a> key)</code> </td> -</tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html#seekToFirst--">seekToFirst</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html#close()">close</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Iterator"> <!-- --> </a> <h3>Methods inherited from interface java.util.Iterator</h3> -<code>forEachRemaining, hasNext, next, remove</code></li> +<code>hasNext, next, remove</code></li> </ul> </li> </ul> @@ -154,39 +133,19 @@ extends java.util.Iterator<<a href=". <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="close--"> +<a name="close()"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>void close()</pre> </li> </ul> -<a name="seekToFirst--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>seekToFirst</h4> -<pre>void seekToFirst()</pre> -</li> -</ul> -<a name="seek-java.lang.Object-"> -<!-- --> -</a><a name="seek-K-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>seek</h4> -<pre>void seek(<a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="type parameter in KeyValueIterator">K</a> key)</pre> -</li> -</ul> </li> </ul> </li> @@ -195,11 +154,9 @@ extends java.util.Iterator<<a href=". </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -214,15 +171,15 @@ extends java.util.Iterator<<a href=". </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/KeyValueIterator.html" target="_top">Frames</a></li> -<li><a href="KeyValueIterator.html" target="_top">No Frames</a></li> +<li><a href="KeyValueIterator.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -242,16 +199,16 @@ extends java.util.Iterator<<a href=". <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.Extension.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.Extension.html?rev=1755637&r1=1755636&r2=1755637&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.Extension.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.Extension.html Tue Aug 9 18:13:38 2016 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_77) on Wed Apr 20 11:00:53 PDT 2016 --> +<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> <title>KeyValueStore.Extension (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-04-20"> +<meta name="date" content="2016-08-09"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="KeyValueStore.Extension (samza-api 0.10.1-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KeyValueStore.Extension (samza-api 0.10.1-SNAPSHOT API)"; } //--> -var methods = {"i0":9,"i1":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><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/kv/KeyValueStore.Extension.html" target="_top">Frames</a></li> -<li><a href="KeyValueStore.Extension.html" target="_top">No Frames</a></li> +<li><a href="KeyValueStore.Extension.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -112,7 +99,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public static class <span class="typeNameLabel">KeyValueStore.Extension</span> +<pre>public static class <span class="strong">KeyValueStore.Extension</span> extends java.lang.Object</pre> <div class="block">Represents an extension for classes that implement <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><code>KeyValueStore</code></a>.</div> </li> @@ -123,33 +110,33 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>static <K,V> void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html#deleteAll-org.apache.samza.storage.kv.KeyValueStore-java.util.List-">deleteAll</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html#deleteAll(org.apache.samza.storage.kv.KeyValueStore,%20java.util.List)">deleteAll</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, java.util.List<K> keys)</code> <div class="block">Deletes the mappings for the specified <code>keys</code> from this key-value store (if such mappings exist).</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <K,V> java.util.Map<K,V></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html#getAll-org.apache.samza.storage.kv.KeyValueStore-java.util.List-">getAll</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html#getAll(org.apache.samza.storage.kv.KeyValueStore,%20java.util.List)">getAll</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, java.util.List<K> keys)</code> <div class="block">Gets the values with which the specified <code>keys</code> are associated.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -165,52 +152,37 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getAll-org.apache.samza.storage.kv.KeyValueStore-java.util.List-"> +<a name="getAll(org.apache.samza.storage.kv.KeyValueStore, java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAll</h4> <pre>public static <K,V> java.util.Map<K,V> getAll(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, - java.util.List<K> keys)</pre> + java.util.List<K> keys)</pre> <div class="block">Gets the values with which the specified <code>keys</code> are associated.</div> -<dl> -<dt><span class="paramLabel">Type Parameters:</span></dt> -<dd><code>K</code> - the type of keys maintained by the specified <code>store</code>.</dd> -<dd><code>V</code> - the type of values maintained by the specified <code>store</code>.</dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>store</code> - the key-value store for which this operation is to be performed.</dd> -<dd><code>keys</code> - the keys with which the associated values are to be fetched.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a map of the keys that were found and their respective values.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys maintained by the specified <code>store</code>.</dd><dd><code>V</code> - the type of values maintained by the specified <code>store</code>.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>store</code> - the key-value store for which this operation is to be performed.</dd><dd><code>keys</code> - the keys with which the associated values are to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of the keys that were found and their respective values.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd></dl> </li> </ul> -<a name="deleteAll-org.apache.samza.storage.kv.KeyValueStore-java.util.List-"> +<a name="deleteAll(org.apache.samza.storage.kv.KeyValueStore, java.util.List)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>deleteAll</h4> <pre>public static <K,V> void deleteAll(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a><K,V> store, - java.util.List<K> keys)</pre> + java.util.List<K> keys)</pre> <div class="block">Deletes the mappings for the specified <code>keys</code> from this key-value store (if such mappings exist).</div> -<dl> -<dt><span class="paramLabel">Type Parameters:</span></dt> -<dd><code>K</code> - the type of keys maintained by the specified <code>store</code>.</dd> -<dd><code>V</code> - the type of values maintained by the specified <code>store</code>.</dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>store</code> - the key-value store for which this operation is to be performed.</dd> -<dd><code>keys</code> - the keys for which the mappings are to be deleted.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys maintained by the specified <code>store</code>.</dd><dd><code>V</code> - the type of values maintained by the specified <code>store</code>.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>store</code> - the key-value store for which this operation is to be performed.</dd><dd><code>keys</code> - the keys for which the mappings are to be deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd></dl> </li> </ul> </li> @@ -221,11 +193,9 @@ extends java.lang.Object</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -240,15 +210,15 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><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/kv/KeyValueStore.Extension.html" target="_top">Frames</a></li> -<li><a href="KeyValueStore.Extension.html" target="_top">No Frames</a></li> +<li><a href="KeyValueStore.Extension.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -268,16 +238,16 @@ extends java.lang.Object</pre> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.html?rev=1755637&r1=1755636&r2=1755637&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/KeyValueStore.html Tue Aug 9 18:13:38 2016 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_77) on Wed Apr 20 11:00:53 PDT 2016 --> +<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> <title>KeyValueStore (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-04-20"> +<meta name="date" content="2016-08-09"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="KeyValueStore (samza-api 0.10.1-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KeyValueStore (samza-api 0.10.1-SNAPSHOT API)"; } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/KeyValueStore.html" target="_top">Frames</a></li> -<li><a href="KeyValueStore.html" target="_top">No Frames</a></li> +<li><a href="KeyValueStore.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -73,19 +60,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -98,14 +85,10 @@ var activeTableTab = "activeTableTab"; <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl> -<dt><span class="paramLabel">Type Parameters:</span></dt> -<dd><code>K</code> - the type of keys maintained by this key-value store.</dd> -<dd><code>V</code> - the type of values maintained by this key-value store.</dd> -</dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys maintained by this key-value store.</dd><dd><code>V</code> - the type of values maintained by this key-value store.</dd></dl> <hr> <br> -<pre>public interface <span class="typeNameLabel">KeyValueStore<K,V></span></pre> +<pre>public interface <span class="strong">KeyValueStore<K,V></span></pre> <div class="block">A key-value store that supports put, get, delete, and range queries.</div> </li> </ul> @@ -115,11 +98,11 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<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"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -127,7 +110,7 @@ var activeTableTab = "activeTableTab"; </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv">KeyValueStore.Extension</a></span></code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv">KeyValueStore.Extension</a></strong></code> <div class="block">Represents an extension for classes that implement <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv"><code>KeyValueStore</code></a>.</div> </td> </tr> @@ -136,80 +119,74 @@ var activeTableTab = "activeTableTab"; </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv">KeyValueIterator</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#all--">all</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#all()">all</a></strong>()</code> <div class="block">Returns an iterator for all entries in this key-value store.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#close--">close</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#close()">close</a></strong>()</code> <div class="block">Closes this key-value store, if applicable, relinquishing any underlying resources.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#delete-K-">delete</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#delete(K)">delete</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</code> <div class="block">Deletes the mapping for the specified <code>key</code> from this key-value store (if such mapping exists).</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#deleteAll-java.util.List-">deleteAll</a></span>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#deleteAll(java.util.List)">deleteAll</a></strong>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</code> <div class="block">Deletes the mappings for the specified <code>keys</code> from this key-value store (if such mappings exist).</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#flush--">flush</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#flush()">flush</a></strong>()</code> <div class="block">Flushes this key-value store, if applicable.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#get-K-">get</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#get(K)">get</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</code> <div class="block">Gets the value associated with the specified <code>key</code>.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#getAll-java.util.List-">getAll</a></span>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#getAll(java.util.List)">getAll</a></strong>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</code> <div class="block">Gets the values with which the specified <code>keys</code> are associated.</div> </td> </tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv">KeyValueIterator</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#newIterator--">newIterator</a></span>()</code> -<div class="block">Return an iterator which is yet to be positions.</div> -</td> -</tr> -<tr id="i8" class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#put-K-V-">put</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#put(K,%20V)">put</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</code> <div class="block">Updates the mapping of the specified key-value pair; Associates the specified <code>key</code> with the specified <code>value</code>.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#putAll-java.util.List-">putAll</a></span>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>>> entries)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#putAll(java.util.List)">putAll</a></strong>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>>> entries)</code> <div class="block">Updates the mappings of the specified key-value <code>entries</code>.</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv">KeyValueIterator</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#range-K-K-">range</a></span>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> from, +<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html#range(K,%20K)">range</a></strong>(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> from, <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> to)</code> <div class="block">Returns an iterator for a sorted range of entries specified by [<code>from</code>, <code>to</code>).</div> </td> @@ -225,13 +202,13 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="get-java.lang.Object-"> +<a name="get(java.lang.Object)"> <!-- --> -</a><a name="get-K-"> +</a><a name="get(K)"> <!-- --> </a> <ul class="blockList"> @@ -239,17 +216,13 @@ var activeTableTab = "activeTableTab"; <h4>get</h4> <pre><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a> get(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</pre> <div class="block">Gets the value associated with the specified <code>key</code>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>key</code> - the key with which the associated value is to be fetched.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>if found, the value associated with the specified <code>key</code>; otherwise, <code>null</code>.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key with which the associated value is to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>if found, the value associated with the specified <code>key</code>; otherwise, <code>null</code>.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> is <code>null</code>.</dd></dl> </li> </ul> -<a name="getAll-java.util.List-"> +<a name="getAll(java.util.List)"> <!-- --> </a> <ul class="blockList"> @@ -257,37 +230,29 @@ var activeTableTab = "activeTableTab"; <h4>getAll</h4> <pre>java.util.Map<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>> getAll(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</pre> <div class="block">Gets the values with which the specified <code>keys</code> are associated.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>keys</code> - the keys with which the associated values are to be fetched.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a map of the keys that were found and their respective values.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - the keys with which the associated values are to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of the keys that were found and their respective values.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd></dl> </li> </ul> -<a name="put-java.lang.Object-java.lang.Object-"> +<a name="put(java.lang.Object,java.lang.Object)"> <!-- --> -</a><a name="put-K-V-"> +</a><a name="put(K, V)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> <pre>void put(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, - <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</pre> + <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</pre> <div class="block">Updates the mapping of the specified key-value pair; Associates the specified <code>key</code> with the specified <code>value</code>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>key</code> - the key with which the specified <code>value</code> is to be associated.</dd> -<dd><code>value</code> - the value with which the specified <code>key</code> is to be associated.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> or <code>value</code> is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key with which the specified <code>value</code> is to be associated.</dd><dd><code>value</code> - the value with which the specified <code>key</code> is to be associated.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> or <code>value</code> is <code>null</code>.</dd></dl> </li> </ul> -<a name="putAll-java.util.List-"> +<a name="putAll(java.util.List)"> <!-- --> </a> <ul class="blockList"> @@ -295,17 +260,14 @@ var activeTableTab = "activeTableTab"; <h4>putAll</h4> <pre>void putAll(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>>> entries)</pre> <div class="block">Updates the mappings of the specified key-value <code>entries</code>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>entries</code> - the updated mappings to put into this key-value store.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if any of the specified <code>entries</code> has <code>null</code> as key or value.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entries</code> - the updated mappings to put into this key-value store.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if any of the specified <code>entries</code> has <code>null</code> as key or value.</dd></dl> </li> </ul> -<a name="delete-java.lang.Object-"> +<a name="delete(java.lang.Object)"> <!-- --> -</a><a name="delete-K-"> +</a><a name="delete(K)"> <!-- --> </a> <ul class="blockList"> @@ -313,15 +275,12 @@ var activeTableTab = "activeTableTab"; <h4>delete</h4> <pre>void delete(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</pre> <div class="block">Deletes the mapping for the specified <code>key</code> from this key-value store (if such mapping exists).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>key</code> - the key for which the mapping is to be deleted.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key for which the mapping is to be deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>key</code> is <code>null</code>.</dd></dl> </li> </ul> -<a name="deleteAll-java.util.List-"> +<a name="deleteAll(java.util.List)"> <!-- --> </a> <ul class="blockList"> @@ -329,42 +288,32 @@ var activeTableTab = "activeTableTab"; <h4>deleteAll</h4> <pre>void deleteAll(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>> keys)</pre> <div class="block">Deletes the mappings for the specified <code>keys</code> from this key-value store (if such mappings exist).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>keys</code> - the keys for which the mappings are to be deleted.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - the keys for which the mappings are to be deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>keys</code> list, or any of the keys, is <code>null</code>.</dd></dl> </li> </ul> -<a name="range-java.lang.Object-java.lang.Object-"> +<a name="range(java.lang.Object,java.lang.Object)"> <!-- --> -</a><a name="range-K-K-"> +</a><a name="range(K, K)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>range</h4> <pre><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv">KeyValueIterator</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>> range(<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> from, - <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> to)</pre> + <a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a> to)</pre> <div class="block">Returns an iterator for a sorted range of entries specified by [<code>from</code>, <code>to</code>). <p><b>API Note:</b> The returned iterator MUST be closed after use. The comparator used for finding entries that belong to the specified range compares the underlying serialized big-endian byte array representation of keys, lexicographically.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>from</code> - the key specifying the low endpoint (inclusive) of the keys in the returned range.</dd> -<dd><code>to</code> - the key specifying the high endpoint (exclusive) of the keys in the returned range.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an iterator for the specified key range.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.NullPointerException</code> - if null is used for <code>from</code> or <code>to</code>.</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="http://en.wikipedia.org/wiki/Lexicographical_order";>Lexicographical order article at Wikipedia</a></p></dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - the key specifying the low endpoint (inclusive) of the keys in the returned range.</dd><dd><code>to</code> - the key specifying the high endpoint (exclusive) of the keys in the returned range.</dd> +<dt><span class="strong">Returns:</span></dt><dd>an iterator for the specified key range.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if null is used for <code>from</code> or <code>to</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/Lexicographical_order";>Lexicographical order article at Wikipedia</a></p></dd></dl> </li> </ul> -<a name="all--"> +<a name="all()"> <!-- --> </a> <ul class="blockList"> @@ -374,28 +323,10 @@ var activeTableTab = "activeTableTab"; <div class="block">Returns an iterator for all entries in this key-value store. <p><b>API Note:</b> The returned iterator MUST be closed after use.</p></div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an iterator for all entries in this key-value store.</dd> -</dl> -</li> -</ul> -<a name="newIterator--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newIterator</h4> -<pre><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv">KeyValueIterator</a><<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>> newIterator()</pre> -<div class="block">Return an iterator which is yet to be positions. This iterator must be positioned - first before a call to next() is made. This iterator MUST be closed after use.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>An iterator</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator for all entries in this key-value store.</dd></dl> </li> </ul> -<a name="close--"> +<a name="close()"> <!-- --> </a> <ul class="blockList"> @@ -405,7 +336,7 @@ var activeTableTab = "activeTableTab"; <div class="block">Closes this key-value store, if applicable, relinquishing any underlying resources.</div> </li> </ul> -<a name="flush--"> +<a name="flush()"> <!-- --> </a> <ul class="blockListLast"> @@ -423,11 +354,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -442,15 +371,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueIterator.html" title="interface in org.apache.samza.storage.kv"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/samza/storage/kv/KeyValueStore.html" target="_top">Frames</a></li> -<li><a href="KeyValueStore.html" target="_top">No Frames</a></li> +<li><a href="KeyValueStore.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> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -467,19 +396,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/package-frame.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/package-frame.html?rev=1755637&r1=1755636&r2=1755637&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/package-frame.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/kv/package-frame.html Tue Aug 9 18:13:38 2016 @@ -2,19 +2,18 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_77) on Wed Apr 20 11:00:53 PDT 2016 --> +<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> <title>org.apache.samza.storage.kv (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-04-20"> +<meta name="date" content="2016-08-09"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <h1 class="bar"><a href="../../../../../org/apache/samza/storage/kv/package-summary.html" target="classFrame">org.apache.samza.storage.kv</a></h1> <div class="indexContainer"> <h2 title="Interfaces">Interfaces</h2> <ul title="Interfaces"> -<li><a href="KeyValueIterator.html" title="interface in org.apache.samza.storage.kv" target="classFrame"><span class="interfaceName">KeyValueIterator</span></a></li> -<li><a href="KeyValueStore.html" title="interface in org.apache.samza.storage.kv" target="classFrame"><span class="interfaceName">KeyValueStore</span></a></li> +<li><a href="KeyValueIterator.html" title="interface in org.apache.samza.storage.kv" target="classFrame"><i>KeyValueIterator</i></a></li> +<li><a href="KeyValueStore.html" title="interface in org.apache.samza.storage.kv" target="classFrame"><i>KeyValueStore</i></a></li> </ul> <h2 title="Classes">Classes</h2> <ul title="Classes">
