| <!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.io, class: TimeRange"> |
| <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.io;</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 org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">/**</span> |
| <span class="source-line-no">023</span><span id="line-23"> * Represents an interval of version timestamps. Presumes timestamps between</span> |
| <span class="source-line-no">024</span><span id="line-24"> * {@link #INITIAL_MIN_TIMESTAMP} and {@link #INITIAL_MAX_TIMESTAMP} only. Gets freaked out if</span> |
| <span class="source-line-no">025</span><span id="line-25"> * passed a timestamp that is < {@link #INITIAL_MIN_TIMESTAMP},</span> |
| <span class="source-line-no">026</span><span id="line-26"> * <p/></span> |
| <span class="source-line-no">027</span><span id="line-27"> * Evaluated according to minStamp &lt;= timestamp &lt; maxStamp or [minStamp,maxStamp) in interval</span> |
| <span class="source-line-no">028</span><span id="line-28"> * notation.</span> |
| <span class="source-line-no">029</span><span id="line-29"> * <p/></span> |
| <span class="source-line-no">030</span><span id="line-30"> * Can be returned and read by clients. Should not be directly created by clients. Thus, all</span> |
| <span class="source-line-no">031</span><span id="line-31"> * constructors are purposely @InterfaceAudience.Private.</span> |
| <span class="source-line-no">032</span><span id="line-32"> * <p/></span> |
| <span class="source-line-no">033</span><span id="line-33"> * Immutable. Thread-safe.</span> |
| <span class="source-line-no">034</span><span id="line-34"> */</span> |
| <span class="source-line-no">035</span><span id="line-35">@InterfaceAudience.Public</span> |
| <span class="source-line-no">036</span><span id="line-36">public final class TimeRange {</span> |
| <span class="source-line-no">037</span><span id="line-37"> public static final long INITIAL_MIN_TIMESTAMP = 0L;</span> |
| <span class="source-line-no">038</span><span id="line-38"> public static final long INITIAL_MAX_TIMESTAMP = Long.MAX_VALUE;</span> |
| <span class="source-line-no">039</span><span id="line-39"> private static final TimeRange ALL_TIME =</span> |
| <span class="source-line-no">040</span><span id="line-40"> new TimeRange(INITIAL_MIN_TIMESTAMP, INITIAL_MAX_TIMESTAMP);</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> public static TimeRange allTime() {</span> |
| <span class="source-line-no">043</span><span id="line-43"> return ALL_TIME;</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"> public static TimeRange at(long ts) {</span> |
| <span class="source-line-no">047</span><span id="line-47"> if (ts < 0 || ts == Long.MAX_VALUE) {</span> |
| <span class="source-line-no">048</span><span id="line-48"> throw new IllegalArgumentException("invalid ts:" + ts);</span> |
| <span class="source-line-no">049</span><span id="line-49"> }</span> |
| <span class="source-line-no">050</span><span id="line-50"> return new TimeRange(ts, ts + 1);</span> |
| <span class="source-line-no">051</span><span id="line-51"> }</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Represents the time interval [minStamp, Long.MAX_VALUE)</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param minStamp the minimum timestamp value, inclusive</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57"> public static TimeRange from(long minStamp) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> check(minStamp, INITIAL_MAX_TIMESTAMP);</span> |
| <span class="source-line-no">059</span><span id="line-59"> return new TimeRange(minStamp, INITIAL_MAX_TIMESTAMP);</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"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Represents the time interval [0, maxStamp)</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param maxStamp the minimum timestamp value, exclusive</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public static TimeRange until(long maxStamp) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> check(INITIAL_MIN_TIMESTAMP, maxStamp);</span> |
| <span class="source-line-no">068</span><span id="line-68"> return new TimeRange(INITIAL_MIN_TIMESTAMP, maxStamp);</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Represents the time interval [minStamp, maxStamp)</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param minStamp the minimum timestamp, inclusive</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param maxStamp the maximum timestamp, exclusive</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public static TimeRange between(long minStamp, long maxStamp) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> check(minStamp, maxStamp);</span> |
| <span class="source-line-no">078</span><span id="line-78"> return new TimeRange(minStamp, maxStamp);</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> private final long minStamp;</span> |
| <span class="source-line-no">082</span><span id="line-82"> private final long maxStamp;</span> |
| <span class="source-line-no">083</span><span id="line-83"> private final boolean allTime;</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /**</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Represents interval [minStamp, maxStamp)</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @param minStamp the minimum timestamp, inclusive</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @param maxStamp the maximum timestamp, exclusive</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @throws IllegalArgumentException if either <0,</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> private TimeRange(long minStamp, long maxStamp) {</span> |
| <span class="source-line-no">092</span><span id="line-92"> this.minStamp = minStamp;</span> |
| <span class="source-line-no">093</span><span id="line-93"> this.maxStamp = maxStamp;</span> |
| <span class="source-line-no">094</span><span id="line-94"> this.allTime = isAllTime(minStamp, maxStamp);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> private static boolean isAllTime(long minStamp, long maxStamp) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> return minStamp == INITIAL_MIN_TIMESTAMP && maxStamp == INITIAL_MAX_TIMESTAMP;</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> private static void check(long minStamp, long maxStamp) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> if (minStamp < 0 || maxStamp < 0) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> throw new IllegalArgumentException(</span> |
| <span class="source-line-no">104</span><span id="line-104"> "Timestamp cannot be negative. minStamp:" + minStamp + ", maxStamp:" + maxStamp);</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"> if (maxStamp < minStamp) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> throw new IllegalArgumentException("maxStamp is smaller than minStamp");</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /** Returns the smallest timestamp that should be considered */</span> |
| <span class="source-line-no">112</span><span id="line-112"> public long getMin() {</span> |
| <span class="source-line-no">113</span><span id="line-113"> return minStamp;</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> /** Returns the biggest timestamp that should be considered */</span> |
| <span class="source-line-no">117</span><span id="line-117"> public long getMax() {</span> |
| <span class="source-line-no">118</span><span id="line-118"> return maxStamp;</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> /**</span> |
| <span class="source-line-no">122</span><span id="line-122"> * Check if it is for all time</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @return true if it is for all time</span> |
| <span class="source-line-no">124</span><span id="line-124"> */</span> |
| <span class="source-line-no">125</span><span id="line-125"> public boolean isAllTime() {</span> |
| <span class="source-line-no">126</span><span id="line-126"> return allTime;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Check if the specified timestamp is within this TimeRange.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * <p/></span> |
| <span class="source-line-no">132</span><span id="line-132"> * Returns true if within interval [minStamp, maxStamp), false if not.</span> |
| <span class="source-line-no">133</span><span id="line-133"> * @param timestamp timestamp to check</span> |
| <span class="source-line-no">134</span><span id="line-134"> * @return true if within TimeRange, false if not</span> |
| <span class="source-line-no">135</span><span id="line-135"> */</span> |
| <span class="source-line-no">136</span><span id="line-136"> public boolean withinTimeRange(long timestamp) {</span> |
| <span class="source-line-no">137</span><span id="line-137"> assert timestamp >= 0;</span> |
| <span class="source-line-no">138</span><span id="line-138"> if (this.allTime) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> return true;</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"> // check if >= minStamp</span> |
| <span class="source-line-no">142</span><span id="line-142"> return (minStamp <= timestamp && timestamp < maxStamp);</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> /**</span> |
| <span class="source-line-no">146</span><span id="line-146"> * Check if the range has any overlap with TimeRange</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @param tr TimeRange</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @return True if there is overlap, false otherwise</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> // This method came from TimeRangeTracker. We used to go there for this function but better</span> |
| <span class="source-line-no">151</span><span id="line-151"> // to come here to the immutable, unsynchronized datastructure at read time.</span> |
| <span class="source-line-no">152</span><span id="line-152"> public boolean includesTimeRange(final TimeRange tr) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> if (this.allTime) {</span> |
| <span class="source-line-no">154</span><span id="line-154"> return true;</span> |
| <span class="source-line-no">155</span><span id="line-155"> }</span> |
| <span class="source-line-no">156</span><span id="line-156"> assert tr.getMin() >= 0;</span> |
| <span class="source-line-no">157</span><span id="line-157"> return getMin() < tr.getMax() && getMax() >= tr.getMin();</span> |
| <span class="source-line-no">158</span><span id="line-158"> }</span> |
| <span class="source-line-no">159</span><span id="line-159"></span> |
| <span class="source-line-no">160</span><span id="line-160"> /**</span> |
| <span class="source-line-no">161</span><span id="line-161"> * Check if the specified timestamp is within or after this TimeRange.</span> |
| <span class="source-line-no">162</span><span id="line-162"> * <p></span> |
| <span class="source-line-no">163</span><span id="line-163"> * Returns true if greater than minStamp, false if not.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @param timestamp timestamp to check</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @return true if within or after TimeRange, false if not</span> |
| <span class="source-line-no">166</span><span id="line-166"> */</span> |
| <span class="source-line-no">167</span><span id="line-167"> public boolean withinOrAfterTimeRange(long timestamp) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> assert timestamp >= 0;</span> |
| <span class="source-line-no">169</span><span id="line-169"> if (allTime) {</span> |
| <span class="source-line-no">170</span><span id="line-170"> return true;</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"> // check if >= minStamp</span> |
| <span class="source-line-no">173</span><span id="line-173"> return timestamp >= minStamp;</span> |
| <span class="source-line-no">174</span><span id="line-174"> }</span> |
| <span class="source-line-no">175</span><span id="line-175"></span> |
| <span class="source-line-no">176</span><span id="line-176"> /**</span> |
| <span class="source-line-no">177</span><span id="line-177"> * Compare the timestamp to timerange.</span> |
| <span class="source-line-no">178</span><span id="line-178"> * @return -1 if timestamp is less than timerange, 0 if timestamp is within timerange, 1 if</span> |
| <span class="source-line-no">179</span><span id="line-179"> * timestamp is greater than timerange</span> |
| <span class="source-line-no">180</span><span id="line-180"> */</span> |
| <span class="source-line-no">181</span><span id="line-181"> public int compare(long timestamp) {</span> |
| <span class="source-line-no">182</span><span id="line-182"> assert timestamp >= 0;</span> |
| <span class="source-line-no">183</span><span id="line-183"> if (this.allTime) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> return 0;</span> |
| <span class="source-line-no">185</span><span id="line-185"> }</span> |
| <span class="source-line-no">186</span><span id="line-186"> if (timestamp < minStamp) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> return -1;</span> |
| <span class="source-line-no">188</span><span id="line-188"> }</span> |
| <span class="source-line-no">189</span><span id="line-189"> return timestamp >= maxStamp ? 1 : 0;</span> |
| <span class="source-line-no">190</span><span id="line-190"> }</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> @Override</span> |
| <span class="source-line-no">193</span><span id="line-193"> public String toString() {</span> |
| <span class="source-line-no">194</span><span id="line-194"> StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">195</span><span id="line-195"> sb.append("maxStamp=");</span> |
| <span class="source-line-no">196</span><span id="line-196"> sb.append(this.maxStamp);</span> |
| <span class="source-line-no">197</span><span id="line-197"> sb.append(", minStamp=");</span> |
| <span class="source-line-no">198</span><span id="line-198"> sb.append(this.minStamp);</span> |
| <span class="source-line-no">199</span><span id="line-199"> return sb.toString();</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
