http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/BookKeeperClientBuilder.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/BookKeeperClientBuilder.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/BookKeeperClientBuilder.html new file mode 100644 index 0000000..a1a4eee --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/BookKeeperClientBuilder.html @@ -0,0 +1,480 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_92) on Sun Jan 08 19:29:04 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BookKeeperClientBuilder (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="BookKeeperClientBuilder (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BookKeeperClientBuilder.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BookKeeperClientBuilder.html" target="_top">Frames</a></li> +<li><a href="BookKeeperClientBuilder.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.distributedlog</div> +<h2 title="Class BookKeeperClientBuilder" class="title">Class BookKeeperClientBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.distributedlog.BookKeeperClientBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BookKeeperClientBuilder</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Builder to build bookkeeper client.</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="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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#bkc-org.apache.distributedlog.BookKeeperClient-">bkc</a></span>(<a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog">BookKeeperClient</a> bkc)</code> +<div class="block">Build BookKeeper client using existing <i>bkc</i> client.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog">BookKeeperClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#build--">build</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#channelFactory-org.jboss.netty.channel.socket.ClientSocketChannelFactory-">channelFactory</a></span>(org.jboss.netty.channel.socket.ClientSocketChannelFactory channelFactory)</code> +<div class="block">Build BookKeeper client using existing <i>channelFactory</i>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#dlConfig-org.apache.distributedlog.DistributedLogConfiguration-">dlConfig</a></span>(<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a> dlConfig)</code> +<div class="block"><i>dlConfig</i> used to configure bookkeeper client.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#featureProvider-com.google.common.base.Optional-">featureProvider</a></span>(com.google.common.base.Optional<org.apache.bookkeeper.feature.FeatureProvider> featureProvider)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#ledgersPath-java.lang.String-">ledgersPath</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ledgersPath)</code> +<div class="block">Set the ledgers path that bookkeeper client is going to access.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#name-java.lang.String-">name</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Set client name.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#newBuilder--">newBuilder</a></span>()</code> +<div class="block">Create a bookkeeper client builder to build bookkeeper clients.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#requestTimer-org.jboss.netty.util.HashedWheelTimer-">requestTimer</a></span>(org.jboss.netty.util.HashedWheelTimer requestTimer)</code> +<div class="block">Build BookKeeper client using existing <i>request timer</i>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#statsLogger-org.apache.bookkeeper.stats.StatsLogger-">statsLogger</a></span>(org.apache.bookkeeper.stats.StatsLogger statsLogger)</code> +<div class="block">Build BookKeeper Client using given stats logger <i>statsLogger</i>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#zkc-org.apache.distributedlog.ZooKeeperClient-">zkc</a></span>(<a href="../../../org/apache/distributedlog/ZooKeeperClient.html" title="class in org.apache.distributedlog">ZooKeeperClient</a> zkc)</code> +<div class="block">Set the zkc used to build bookkeeper client.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#zkServers-java.lang.String-">zkServers</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> zkServers)</code> +<div class="block">Set the zookeeper servers that bookkeeper client would connect to.</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.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newBuilder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newBuilder</h4> +<pre>public static <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> newBuilder()</pre> +<div class="block">Create a bookkeeper client builder to build bookkeeper clients.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>bookkeeper client builder.</dd> +</dl> +</li> +</ul> +<a name="name-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>name</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> name(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Set client name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - client name.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="dlConfig-org.apache.distributedlog.DistributedLogConfiguration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dlConfig</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> dlConfig(<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a> dlConfig)</pre> +<div class="block"><i>dlConfig</i> used to configure bookkeeper client.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dlConfig</code> - distributedlog config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder.</dd> +</dl> +</li> +</ul> +<a name="zkc-org.apache.distributedlog.ZooKeeperClient-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>zkc</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> zkc(<a href="../../../org/apache/distributedlog/ZooKeeperClient.html" title="class in org.apache.distributedlog">ZooKeeperClient</a> zkc)</pre> +<div class="block">Set the zkc used to build bookkeeper client. If a zookeeper client is provided in this + method, bookkeeper client will use it rather than creating a brand new one.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>zkc</code> - zookeeper client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#zkServers-java.lang.String-"><code>zkServers(String)</code></a></dd> +</dl> +</li> +</ul> +<a name="zkServers-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>zkServers</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> zkServers(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> zkServers)</pre> +<div class="block">Set the zookeeper servers that bookkeeper client would connect to. If no zookeeper client + is provided by <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#zkc-org.apache.distributedlog.ZooKeeperClient-"><code>zkc(ZooKeeperClient)</code></a>, bookkeeper client will use the given string + to create a brand new zookeeper client.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>zkServers</code> - zookeeper servers that bookkeeper client would connect to.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html#zkc-org.apache.distributedlog.ZooKeeperClient-"><code>zkc(ZooKeeperClient)</code></a></dd> +</dl> +</li> +</ul> +<a name="ledgersPath-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ledgersPath</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> ledgersPath(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ledgersPath)</pre> +<div class="block">Set the ledgers path that bookkeeper client is going to access.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ledgersPath</code> - ledgers path</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>AbstractConfiguration.getZkLedgersRootPath()</code></dd> +</dl> +</li> +</ul> +<a name="bkc-org.apache.distributedlog.BookKeeperClient-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bkc</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> bkc(<a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog">BookKeeperClient</a> bkc)</pre> +<div class="block">Build BookKeeper client using existing <i>bkc</i> client.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bkc</code> - bookkeeper client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="channelFactory-org.jboss.netty.channel.socket.ClientSocketChannelFactory-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>channelFactory</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> channelFactory(org.jboss.netty.channel.socket.ClientSocketChannelFactory channelFactory)</pre> +<div class="block">Build BookKeeper client using existing <i>channelFactory</i>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>channelFactory</code> - Channel Factory used to build bookkeeper client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>bookkeeper client builder.</dd> +</dl> +</li> +</ul> +<a name="requestTimer-org.jboss.netty.util.HashedWheelTimer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestTimer</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> requestTimer(org.jboss.netty.util.HashedWheelTimer requestTimer)</pre> +<div class="block">Build BookKeeper client using existing <i>request timer</i>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>requestTimer</code> - HashedWheelTimer used to build bookkeeper client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>bookkeeper client builder.</dd> +</dl> +</li> +</ul> +<a name="statsLogger-org.apache.bookkeeper.stats.StatsLogger-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>statsLogger</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> statsLogger(org.apache.bookkeeper.stats.StatsLogger statsLogger)</pre> +<div class="block">Build BookKeeper Client using given stats logger <i>statsLogger</i>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>statsLogger</code> - stats logger to report stats</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder.</dd> +</dl> +</li> +</ul> +<a name="featureProvider-com.google.common.base.Optional-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>featureProvider</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog">BookKeeperClientBuilder</a> featureProvider(com.google.common.base.Optional<org.apache.bookkeeper.feature.FeatureProvider> featureProvider)</pre> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog">BookKeeperClient</a> build()</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BookKeeperClientBuilder.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BookKeeperClientBuilder.html" target="_top">Frames</a></li> +<li><a href="BookKeeperClientBuilder.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DLSN.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DLSN.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DLSN.html new file mode 100644 index 0000000..6d83bcc --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DLSN.html @@ -0,0 +1,683 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DLSN (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="DLSN (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DLSN.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/Entry.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/DLSN.html" target="_top">Frames</a></li> +<li><a href="DLSN.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><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.distributedlog</div> +<h2 title="Class DLSN" class="title">Class DLSN</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.distributedlog.DLSN</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DLSN</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></pre> +<div class="block">DistributedLog Sequence Number (DLSN) is the system generated sequence number for log record. + + <p>DLSN is comprised with 3 components: + <ul> + <li>LogSegment Sequence Number: the sequence number of log segment that the record is written in + <li>Entry Id: the entry id of the entry that the record is batched in + <li>Slot Id: the slot id that the record is in the entry + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog"><code>LogRecordWithDLSN</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#InitialDLSN">InitialDLSN</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#InvalidDLSN">InvalidDLSN</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#NonInclusiveLowerBound">NonInclusiveLowerBound</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#VERSION0">VERSION0</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#VERSION1">VERSION1</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#DLSN-long-long-long-">DLSN</a></span>(long logSegmentSequenceNo, + long entryId, + long slotId)</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="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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#compareTo-org.apache.distributedlog.DLSN-">compareTo</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> that)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#deserialize-java.lang.String-">deserialize</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dlsn)</code> +<div class="block">Deserialize the DLSN from base64 encoded string <code>dlsn</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#deserializeBytes-byte:A-">deserializeBytes</a></span>(byte[] data)</code> +<div class="block">Deserialize the DLSN from bytes array.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#equals-java.lang.Object-">equals</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#getEntryId--">getEntryId</a></span>()</code> +<div class="block">Return the entry id of the batch that the record is written to.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#getLogSegmentSequenceNo--">getLogSegmentSequenceNo</a></span>()</code> +<div class="block">Return the sequence number of the log segment that the record is written to.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#getNextDLSN--">getNextDLSN</a></span>()</code> +<div class="block">Positions to a DLSN greater than the current value.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#getSlotId--">getSlotId</a></span>()</code> +<div class="block">Return the slot id in the batch that the record is written to.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#positionOnTheNextLedger--">positionOnTheNextLedger</a></span>()</code> +<div class="block">Positions to next log segment than the current value.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#serialize--">serialize</a></span>()</code> +<div class="block">Serialize the DLSN into base64 encoded string.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#serialize-byte-">serialize</a></span>(byte version)</code> +<div class="block">Serialize the DLSN into base64 encoded string with given <code>version</code>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#serializeBytes--">serializeBytes</a></span>()</code> +<div class="block">Serialize the DLSN into bytes with current version.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#serializeBytes-byte-">serializeBytes</a></span>(byte version)</code> +<div class="block">Serialize the DLSN into bytes with given <code>version</code>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DLSN.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api /java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="VERSION0"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VERSION0</h4> +<pre>public static final byte VERSION0</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.DLSN.VERSION0">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="VERSION1"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VERSION1</h4> +<pre>public static final byte VERSION1</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.DLSN.VERSION1">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="InitialDLSN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>InitialDLSN</h4> +<pre>public static final <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> InitialDLSN</pre> +</li> +</ul> +<a name="NonInclusiveLowerBound"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NonInclusiveLowerBound</h4> +<pre>public static final <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> NonInclusiveLowerBound</pre> +</li> +</ul> +<a name="InvalidDLSN"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InvalidDLSN</h4> +<pre>public static final <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> InvalidDLSN</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DLSN-long-long-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DLSN</h4> +<pre>public DLSN(long logSegmentSequenceNo, + long entryId, + long slotId)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLogSegmentSequenceNo--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogSegmentSequenceNo</h4> +<pre>public long getLogSegmentSequenceNo()</pre> +<div class="block">Return the sequence number of the log segment that the record is written to.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sequence number of the log segment that the record is written to.</dd> +</dl> +</li> +</ul> +<a name="getEntryId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntryId</h4> +<pre>public long getEntryId()</pre> +<div class="block">Return the entry id of the batch that the record is written to.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>entry id of the batch that the record is written to.</dd> +</dl> +</li> +</ul> +<a name="getSlotId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSlotId</h4> +<pre>public long getSlotId()</pre> +<div class="block">Return the slot id in the batch that the record is written to.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>slot id in the batch that the record is written to.</dd> +</dl> +</li> +</ul> +<a name="compareTo-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> that)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></code></dd> +</dl> +</li> +</ul> +<a name="serializeBytes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serializeBytes</h4> +<pre>public byte[] serializeBytes()</pre> +<div class="block">Serialize the DLSN into bytes with current version.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized bytes</dd> +</dl> +</li> +</ul> +<a name="serializeBytes-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serializeBytes</h4> +<pre>public byte[] serializeBytes(byte version)</pre> +<div class="block">Serialize the DLSN into bytes with given <code>version</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>version</code> - version to serialize the DLSN</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized bytes</dd> +</dl> +</li> +</ul> +<a name="serialize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serialize</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serialize()</pre> +<div class="block">Serialize the DLSN into base64 encoded string.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>serialized base64 string</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/DLSN.html#serializeBytes--"><code>serializeBytes()</code></a></dd> +</dl> +</li> +</ul> +<a name="serialize-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serialize</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serialize(byte version)</pre> +<div class="block">Serialize the DLSN into base64 encoded string with given <code>version</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>version</code> - version to serialize the DLSN</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized base64 string</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/DLSN.html#serializeBytes-byte-"><code>serializeBytes(byte)</code></a></dd> +</dl> +</li> +</ul> +<a name="deserialize-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deserialize</h4> +<pre>public static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> deserialize(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dlsn)</pre> +<div class="block">Deserialize the DLSN from base64 encoded string <code>dlsn</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dlsn</code> - base64 encoded string</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>dlsn</dd> +</dl> +</li> +</ul> +<a name="deserializeBytes-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deserializeBytes</h4> +<pre>public static <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> deserializeBytes(byte[] data)</pre> +<div class="block">Deserialize the DLSN from bytes array.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>data</code> - serialized bytes</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>dlsn</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="getNextDLSN--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextDLSN</h4> +<pre>public <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> getNextDLSN()</pre> +<div class="block">Positions to a DLSN greater than the current value. + + <p>This may not correspond to an actual LogRecord, its just used by the positioning logic + to position the reader.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the next DLSN</dd> +</dl> +</li> +</ul> +<a name="positionOnTheNextLedger--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>positionOnTheNextLedger</h4> +<pre>public <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> positionOnTheNextLedger()</pre> +<div class="block">Positions to next log segment than the current value. + + <p>this may not correspond to an actual LogRecord, its just used by the positioning logic + to position the reader.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the next DLSN</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DLSN.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/Entry.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/DLSN.html" target="_top">Frames</a></li> +<li><a href="DLSN.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><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>