| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.wal, interface: WAL"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.wal;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.List;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Set;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.wal.WALActionsListener;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.regionserver.wal.WALSyncTimeoutIOException;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.replication.regionserver.WALFileLengthProvider;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35">/**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * A Write Ahead Log (WAL) provides service for reading, writing waledits. This interface provides</span> |
| <span class="source-line-no">037</span><span id="line-37"> * APIs for WAL users (such as RegionServer) to use the WAL (do append, sync, etc). Note that some</span> |
| <span class="source-line-no">038</span><span id="line-38"> * internals, such as log rolling and performance evaluation tools, will use WAL.equals to determine</span> |
| <span class="source-line-no">039</span><span id="line-39"> * if they have already seen a given WAL.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">043</span><span id="line-43">public interface WAL extends Closeable, WALFileLengthProvider {</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> /**</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Used to initialize the WAL. Usually this is for creating the first writer.</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> default void init() throws IOException {</span> |
| <span class="source-line-no">049</span><span id="line-49"> }</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Registers WALActionsListener</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> void registerWALActionsListener(final WALActionsListener listener);</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /**</span> |
| <span class="source-line-no">057</span><span id="line-57"> * Unregisters WALActionsListener</span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59"> boolean unregisterWALActionsListener(final WALActionsListener listener);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Roll the log writer. That is, start writing log messages to a new file.</span> |
| <span class="source-line-no">063</span><span id="line-63"> * <p/></span> |
| <span class="source-line-no">064</span><span id="line-64"> * The implementation is synchronized in order to make sure there's one rollWriter running at any</span> |
| <span class="source-line-no">065</span><span id="line-65"> * given time.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @return If lots of logs, flush the stores of returned regions so next time through we can clean</span> |
| <span class="source-line-no">067</span><span id="line-67"> * logs. Returns null if nothing to flush. Names are actual region names as returned by</span> |
| <span class="source-line-no">068</span><span id="line-68"> * {@link RegionInfo#getEncodedName()}</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> Map<byte[], List<byte[]>> rollWriter() throws FailedLogCloseException, IOException;</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Roll the log writer. That is, start writing log messages to a new file.</span> |
| <span class="source-line-no">074</span><span id="line-74"> * <p/></span> |
| <span class="source-line-no">075</span><span id="line-75"> * The implementation is synchronized in order to make sure there's one rollWriter running at any</span> |
| <span class="source-line-no">076</span><span id="line-76"> * given time. If true, force creation of a new writer even if no entries have been written to the</span> |
| <span class="source-line-no">077</span><span id="line-77"> * current writer</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @return If lots of logs, flush the stores of returned regions so next time through we can clean</span> |
| <span class="source-line-no">079</span><span id="line-79"> * logs. Returns null if nothing to flush. Names are actual region names as returned by</span> |
| <span class="source-line-no">080</span><span id="line-80"> * {@link RegionInfo#getEncodedName()}</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> Map<byte[], List<byte[]>> rollWriter(boolean force) throws IOException;</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Stop accepting new writes. If we have unsynced writes still in buffer, sync them. Extant edits</span> |
| <span class="source-line-no">086</span><span id="line-86"> * are left in place in backing storage to be replayed later.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> void shutdown() throws IOException;</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Caller no longer needs any edits from this WAL. Implementers are free to reclaim underlying</span> |
| <span class="source-line-no">092</span><span id="line-92"> * resources after this call; i.e. filesystem based WALs can archive or delete files.</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> @Override</span> |
| <span class="source-line-no">095</span><span id="line-95"> void close() throws IOException;</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Append a set of data edits to the WAL. 'Data' here means that the content in the edits will</span> |
| <span class="source-line-no">099</span><span id="line-99"> * also have transitioned through the memstore.</span> |
| <span class="source-line-no">100</span><span id="line-100"> * <p/></span> |
| <span class="source-line-no">101</span><span id="line-101"> * The WAL is not flushed/sync'd after this transaction completes BUT on return this edit must</span> |
| <span class="source-line-no">102</span><span id="line-102"> * have its region edit/sequence id assigned else it messes up our unification of mvcc and</span> |
| <span class="source-line-no">103</span><span id="line-103"> * sequenceid. On return <code>key</code> will have the region edit/sequence id filled in.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @param info the regioninfo associated with append</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param key Modified by this call; we add to it this edits region edit/sequence id.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @param edits Edits to append. MAY CONTAIN NO EDITS for case where we want to get an edit</span> |
| <span class="source-line-no">107</span><span id="line-107"> * sequence id that is after all currently appended edits.</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @return Returns a 'transaction id' and <code>key</code> will have the region edit/sequence id</span> |
| <span class="source-line-no">109</span><span id="line-109"> * in it.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @see #appendMarker(RegionInfo, WALKeyImpl, WALEdit)</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> long appendData(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException;</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * Append an operational 'meta' event marker edit to the WAL. A marker meta edit could be a</span> |
| <span class="source-line-no">116</span><span id="line-116"> * FlushDescriptor, a compaction marker, or a region event marker; e.g. region open or region</span> |
| <span class="source-line-no">117</span><span id="line-117"> * close. The difference between a 'marker' append and a 'data' append as in</span> |
| <span class="source-line-no">118</span><span id="line-118"> * {@link #appendData(RegionInfo, WALKeyImpl, WALEdit)}is that a marker will not have transitioned</span> |
| <span class="source-line-no">119</span><span id="line-119"> * through the memstore.</span> |
| <span class="source-line-no">120</span><span id="line-120"> * <p/></span> |
| <span class="source-line-no">121</span><span id="line-121"> * The WAL is not flushed/sync'd after this transaction completes BUT on return this edit must</span> |
| <span class="source-line-no">122</span><span id="line-122"> * have its region edit/sequence id assigned else it messes up our unification of mvcc and</span> |
| <span class="source-line-no">123</span><span id="line-123"> * sequenceid. On return <code>key</code> will have the region edit/sequence id filled in.</span> |
| <span class="source-line-no">124</span><span id="line-124"> * @param info the regioninfo associated with append</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @param key Modified by this call; we add to it this edits region edit/sequence id.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @param edits Edits to append. MAY CONTAIN NO EDITS for case where we want to get an edit</span> |
| <span class="source-line-no">127</span><span id="line-127"> * sequence id that is after all currently appended edits.</span> |
| <span class="source-line-no">128</span><span id="line-128"> * @return Returns a 'transaction id' and <code>key</code> will have the region edit/sequence id</span> |
| <span class="source-line-no">129</span><span id="line-129"> * in it.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @see #appendData(RegionInfo, WALKeyImpl, WALEdit)</span> |
| <span class="source-line-no">131</span><span id="line-131"> */</span> |
| <span class="source-line-no">132</span><span id="line-132"> long appendMarker(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException;</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /**</span> |
| <span class="source-line-no">135</span><span id="line-135"> * updates the seuence number of a specific store. depending on the flag: replaces current seq</span> |
| <span class="source-line-no">136</span><span id="line-136"> * number if the given seq id is bigger, or even if it is lower than existing one</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> void updateStore(byte[] encodedRegionName, byte[] familyName, Long sequenceid,</span> |
| <span class="source-line-no">139</span><span id="line-139"> boolean onlyIfGreater);</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * Sync what we have in the WAL.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.</span> |
| <span class="source-line-no">144</span><span id="line-144"> */</span> |
| <span class="source-line-no">145</span><span id="line-145"> void sync() throws IOException;</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Sync the WAL if the txId was not already sync'd.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @param txid Transaction id to sync to.</span> |
| <span class="source-line-no">150</span><span id="line-150"> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.</span> |
| <span class="source-line-no">151</span><span id="line-151"> */</span> |
| <span class="source-line-no">152</span><span id="line-152"> void sync(long txid) throws IOException;</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> /**</span> |
| <span class="source-line-no">155</span><span id="line-155"> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush</span> |
| <span class="source-line-no">156</span><span id="line-156"> * vs hsync.</span> |
| <span class="source-line-no">157</span><span id="line-157"> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.</span> |
| <span class="source-line-no">158</span><span id="line-158"> */</span> |
| <span class="source-line-no">159</span><span id="line-159"> default void sync(boolean forceSync) throws IOException {</span> |
| <span class="source-line-no">160</span><span id="line-160"> sync();</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> /**</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @param txid Transaction id to sync to.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush</span> |
| <span class="source-line-no">166</span><span id="line-166"> * vs hsync.</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.</span> |
| <span class="source-line-no">168</span><span id="line-168"> */</span> |
| <span class="source-line-no">169</span><span id="line-169"> default void sync(long txid, boolean forceSync) throws IOException {</span> |
| <span class="source-line-no">170</span><span id="line-170"> sync(txid);</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> /**</span> |
| <span class="source-line-no">174</span><span id="line-174"> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores in order to be</span> |
| <span class="source-line-no">175</span><span id="line-175"> * able to do accounting to figure which WALs can be let go. This method tells WAL that some</span> |
| <span class="source-line-no">176</span><span id="line-176"> * region is about to flush. The flush can be the whole region or for a column family of the</span> |
| <span class="source-line-no">177</span><span id="line-177"> * region only.</span> |
| <span class="source-line-no">178</span><span id="line-178"> * <p></span> |
| <span class="source-line-no">179</span><span id="line-179"> * Currently, it is expected that the update lock is held for the region; i.e. no concurrent</span> |
| <span class="source-line-no">180</span><span id="line-180"> * appends while we set up cache flush.</span> |
| <span class="source-line-no">181</span><span id="line-181"> * @param families Families to flush. May be a subset of all families in the region.</span> |
| <span class="source-line-no">182</span><span id="line-182"> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if we are</span> |
| <span class="source-line-no">183</span><span id="line-183"> * flushing a subset of all families but there are no edits in those families not being</span> |
| <span class="source-line-no">184</span><span id="line-184"> * flushed; in other words, this is effectively same as a flush of all of the region</span> |
| <span class="source-line-no">185</span><span id="line-185"> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the</span> |
| <span class="source-line-no">186</span><span id="line-186"> * oldest/lowest outstanding edit.</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @see #completeCacheFlush(byte[], long)</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @see #abortCacheFlush(byte[])</span> |
| <span class="source-line-no">189</span><span id="line-189"> */</span> |
| <span class="source-line-no">190</span><span id="line-190"> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);</span> |
| <span class="source-line-no">193</span><span id="line-193"></span> |
| <span class="source-line-no">194</span><span id="line-194"> /**</span> |
| <span class="source-line-no">195</span><span id="line-195"> * Complete the cache flush.</span> |
| <span class="source-line-no">196</span><span id="line-196"> * @param encodedRegionName Encoded region name.</span> |
| <span class="source-line-no">197</span><span id="line-197"> * @param maxFlushedSeqId The maxFlushedSeqId for this flush. There is no edit in memory that is</span> |
| <span class="source-line-no">198</span><span id="line-198"> * less that this sequence id.</span> |
| <span class="source-line-no">199</span><span id="line-199"> * @see #startCacheFlush(byte[], Set)</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @see #abortCacheFlush(byte[])</span> |
| <span class="source-line-no">201</span><span id="line-201"> */</span> |
| <span class="source-line-no">202</span><span id="line-202"> void completeCacheFlush(final byte[] encodedRegionName, long maxFlushedSeqId);</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> /**</span> |
| <span class="source-line-no">205</span><span id="line-205"> * Abort a cache flush. Call if the flush fails. Note that the only recovery for an aborted flush</span> |
| <span class="source-line-no">206</span><span id="line-206"> * currently is a restart of the regionserver so the snapshot content dropped by the failure gets</span> |
| <span class="source-line-no">207</span><span id="line-207"> * restored to the memstore.</span> |
| <span class="source-line-no">208</span><span id="line-208"> * @param encodedRegionName Encoded region name.</span> |
| <span class="source-line-no">209</span><span id="line-209"> */</span> |
| <span class="source-line-no">210</span><span id="line-210"> void abortCacheFlush(byte[] encodedRegionName);</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> /** Returns Coprocessor host. */</span> |
| <span class="source-line-no">213</span><span id="line-213"> WALCoprocessorHost getCoprocessorHost();</span> |
| <span class="source-line-no">214</span><span id="line-214"></span> |
| <span class="source-line-no">215</span><span id="line-215"> /**</span> |
| <span class="source-line-no">216</span><span id="line-216"> * Gets the earliest unflushed sequence id in the memstore for the store.</span> |
| <span class="source-line-no">217</span><span id="line-217"> * @param encodedRegionName The region to get the number for.</span> |
| <span class="source-line-no">218</span><span id="line-218"> * @param familyName The family to get the number for.</span> |
| <span class="source-line-no">219</span><span id="line-219"> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.</span> |
| <span class="source-line-no">220</span><span id="line-220"> */</span> |
| <span class="source-line-no">221</span><span id="line-221"> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> /**</span> |
| <span class="source-line-no">224</span><span id="line-224"> * Tell the WAL that when creating new writer you can skip creating the remote writer.</span> |
| <span class="source-line-no">225</span><span id="line-225"> * <p></span> |
| <span class="source-line-no">226</span><span id="line-226"> * Used by sync replication for switching states from ACTIVE, where the remote cluster is broken.</span> |
| <span class="source-line-no">227</span><span id="line-227"> */</span> |
| <span class="source-line-no">228</span><span id="line-228"> default void skipRemoteWAL(boolean markerEditOnly) {</span> |
| <span class="source-line-no">229</span><span id="line-229"> }</span> |
| <span class="source-line-no">230</span><span id="line-230"></span> |
| <span class="source-line-no">231</span><span id="line-231"> /**</span> |
| <span class="source-line-no">232</span><span id="line-232"> * Human readable identifying information about the state of this WAL. Implementors are encouraged</span> |
| <span class="source-line-no">233</span><span id="line-233"> * to include information appropriate for debugging. Consumers are advised not to rely on the</span> |
| <span class="source-line-no">234</span><span id="line-234"> * details of the returned String; it does not have a defined structure.</span> |
| <span class="source-line-no">235</span><span id="line-235"> */</span> |
| <span class="source-line-no">236</span><span id="line-236"> @Override</span> |
| <span class="source-line-no">237</span><span id="line-237"> String toString();</span> |
| <span class="source-line-no">238</span><span id="line-238"></span> |
| <span class="source-line-no">239</span><span id="line-239"> /**</span> |
| <span class="source-line-no">240</span><span id="line-240"> * Utility class that lets us keep track of the edit with it's key.</span> |
| <span class="source-line-no">241</span><span id="line-241"> */</span> |
| <span class="source-line-no">242</span><span id="line-242"> class Entry {</span> |
| <span class="source-line-no">243</span><span id="line-243"> private final WALEdit edit;</span> |
| <span class="source-line-no">244</span><span id="line-244"> private final WALKeyImpl key;</span> |
| <span class="source-line-no">245</span><span id="line-245"></span> |
| <span class="source-line-no">246</span><span id="line-246"> public Entry() {</span> |
| <span class="source-line-no">247</span><span id="line-247"> this(new WALKeyImpl(), new WALEdit());</span> |
| <span class="source-line-no">248</span><span id="line-248"> }</span> |
| <span class="source-line-no">249</span><span id="line-249"></span> |
| <span class="source-line-no">250</span><span id="line-250"> /**</span> |
| <span class="source-line-no">251</span><span id="line-251"> * Constructor for both params</span> |
| <span class="source-line-no">252</span><span id="line-252"> * @param edit log's edit</span> |
| <span class="source-line-no">253</span><span id="line-253"> * @param key log's key</span> |
| <span class="source-line-no">254</span><span id="line-254"> */</span> |
| <span class="source-line-no">255</span><span id="line-255"> public Entry(WALKeyImpl key, WALEdit edit) {</span> |
| <span class="source-line-no">256</span><span id="line-256"> this.key = key;</span> |
| <span class="source-line-no">257</span><span id="line-257"> this.edit = edit;</span> |
| <span class="source-line-no">258</span><span id="line-258"> }</span> |
| <span class="source-line-no">259</span><span id="line-259"></span> |
| <span class="source-line-no">260</span><span id="line-260"> /**</span> |
| <span class="source-line-no">261</span><span id="line-261"> * Gets the edit</span> |
| <span class="source-line-no">262</span><span id="line-262"> */</span> |
| <span class="source-line-no">263</span><span id="line-263"> public WALEdit getEdit() {</span> |
| <span class="source-line-no">264</span><span id="line-264"> return edit;</span> |
| <span class="source-line-no">265</span><span id="line-265"> }</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> /**</span> |
| <span class="source-line-no">268</span><span id="line-268"> * Gets the key</span> |
| <span class="source-line-no">269</span><span id="line-269"> */</span> |
| <span class="source-line-no">270</span><span id="line-270"> public WALKeyImpl getKey() {</span> |
| <span class="source-line-no">271</span><span id="line-271"> return key;</span> |
| <span class="source-line-no">272</span><span id="line-272"> }</span> |
| <span class="source-line-no">273</span><span id="line-273"></span> |
| <span class="source-line-no">274</span><span id="line-274"> @Override</span> |
| <span class="source-line-no">275</span><span id="line-275"> public String toString() {</span> |
| <span class="source-line-no">276</span><span id="line-276"> return this.key + "=" + this.edit;</span> |
| <span class="source-line-no">277</span><span id="line-277"> }</span> |
| <span class="source-line-no">278</span><span id="line-278"> }</span> |
| <span class="source-line-no">279</span><span id="line-279">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
