blob: 9094f2399d809c767806dc02f67b27ab5f482f04 [file] [log] [blame]
<!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.util, class: SimplePositionedByteRange">
<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.util;</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"> * Extends the basic {@link SimpleMutableByteRange} implementation with position support and it is a</span>
<span class="source-line-no">024</span><span id="line-24"> * readonly version. {@code position} is considered transient, not fundamental to the definition of</span>
<span class="source-line-no">025</span><span id="line-25"> * the range, and does not participate in {@link #compareTo(ByteRange)}, {@link #hashCode()}, or</span>
<span class="source-line-no">026</span><span id="line-26"> * {@link #equals(Object)}. {@code Position} is retained by copy operations.</span>
<span class="source-line-no">027</span><span id="line-27"> */</span>
<span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.Public</span>
<span class="source-line-no">029</span><span id="line-29">@edu.umd.cs.findbugs.annotations.SuppressWarnings("EQ_DOESNT_OVERRIDE_EQUALS")</span>
<span class="source-line-no">030</span><span id="line-30">public class SimplePositionedByteRange extends AbstractPositionedByteRange {</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> /**</span>
<span class="source-line-no">033</span><span id="line-33"> * Create a new {@code PositionedByteRange} lacking a backing array and with an undefined</span>
<span class="source-line-no">034</span><span id="line-34"> * viewport.</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36"> public SimplePositionedByteRange() {</span>
<span class="source-line-no">037</span><span id="line-37"> super();</span>
<span class="source-line-no">038</span><span id="line-38"> }</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> /**</span>
<span class="source-line-no">041</span><span id="line-41"> * Create a new {@code PositionedByteRange} over a new backing array of size {@code capacity}. The</span>
<span class="source-line-no">042</span><span id="line-42"> * range's offset and length are 0 and {@code capacity}, respectively.</span>
<span class="source-line-no">043</span><span id="line-43"> * @param capacity the size of the backing array.</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45"> public SimplePositionedByteRange(int capacity) {</span>
<span class="source-line-no">046</span><span id="line-46"> this(new byte[capacity]);</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> /**</span>
<span class="source-line-no">050</span><span id="line-50"> * Create a new {@code PositionedByteRange} over the provided {@code bytes}.</span>
<span class="source-line-no">051</span><span id="line-51"> * @param bytes The array to wrap.</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53"> public SimplePositionedByteRange(byte[] bytes) {</span>
<span class="source-line-no">054</span><span id="line-54"> set(bytes);</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"> /**</span>
<span class="source-line-no">058</span><span id="line-58"> * Create a new {@code PositionedByteRange} over the provided {@code bytes}.</span>
<span class="source-line-no">059</span><span id="line-59"> * @param bytes The array to wrap.</span>
<span class="source-line-no">060</span><span id="line-60"> * @param offset The offset into {@code bytes} considered the beginning of this range.</span>
<span class="source-line-no">061</span><span id="line-61"> * @param length The length of this range.</span>
<span class="source-line-no">062</span><span id="line-62"> */</span>
<span class="source-line-no">063</span><span id="line-63"> public SimplePositionedByteRange(byte[] bytes, int offset, int length) {</span>
<span class="source-line-no">064</span><span id="line-64"> set(bytes, offset, length);</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> @Override</span>
<span class="source-line-no">068</span><span id="line-68"> public PositionedByteRange set(int capacity) {</span>
<span class="source-line-no">069</span><span id="line-69"> if (super.bytes != null) {</span>
<span class="source-line-no">070</span><span id="line-70"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> return super.set(capacity);</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> @Override</span>
<span class="source-line-no">076</span><span id="line-76"> public PositionedByteRange set(byte[] bytes) {</span>
<span class="source-line-no">077</span><span id="line-77"> if (super.bytes != null) {</span>
<span class="source-line-no">078</span><span id="line-78"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"> return super.set(bytes);</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> @Override</span>
<span class="source-line-no">084</span><span id="line-84"> public PositionedByteRange set(byte[] bytes, int offset, int length) {</span>
<span class="source-line-no">085</span><span id="line-85"> if (super.bytes != null) {</span>
<span class="source-line-no">086</span><span id="line-86"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"> return super.set(bytes, offset, length);</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"> @Override</span>
<span class="source-line-no">092</span><span id="line-92"> public PositionedByteRange put(byte val) {</span>
<span class="source-line-no">093</span><span id="line-93"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> public PositionedByteRange putShort(short val) {</span>
<span class="source-line-no">098</span><span id="line-98"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">102</span><span id="line-102"> public PositionedByteRange putInt(int val) {</span>
<span class="source-line-no">103</span><span id="line-103"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> @Override</span>
<span class="source-line-no">107</span><span id="line-107"> public PositionedByteRange putLong(long val) {</span>
<span class="source-line-no">108</span><span id="line-108"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">112</span><span id="line-112"> public int putVLong(long val) {</span>
<span class="source-line-no">113</span><span id="line-113"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">117</span><span id="line-117"> public PositionedByteRange put(byte[] val) {</span>
<span class="source-line-no">118</span><span id="line-118"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">122</span><span id="line-122"> public PositionedByteRange put(byte[] val, int offset, int length) {</span>
<span class="source-line-no">123</span><span id="line-123"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> @Override</span>
<span class="source-line-no">127</span><span id="line-127"> public PositionedByteRange get(int index, byte[] dst) {</span>
<span class="source-line-no">128</span><span id="line-128"> super.get(index, dst);</span>
<span class="source-line-no">129</span><span id="line-129"> return this;</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> @Override</span>
<span class="source-line-no">133</span><span id="line-133"> public PositionedByteRange get(int index, byte[] dst, int offset, int length) {</span>
<span class="source-line-no">134</span><span id="line-134"> super.get(index, dst, offset, length);</span>
<span class="source-line-no">135</span><span id="line-135"> return this;</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> @Override</span>
<span class="source-line-no">139</span><span id="line-139"> public PositionedByteRange put(int index, byte val) {</span>
<span class="source-line-no">140</span><span id="line-140"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">141</span><span id="line-141"> }</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> @Override</span>
<span class="source-line-no">144</span><span id="line-144"> public PositionedByteRange putShort(int index, short val) {</span>
<span class="source-line-no">145</span><span id="line-145"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">149</span><span id="line-149"> public PositionedByteRange putInt(int index, int val) {</span>
<span class="source-line-no">150</span><span id="line-150"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> @Override</span>
<span class="source-line-no">154</span><span id="line-154"> public int putVLong(int index, long val) {</span>
<span class="source-line-no">155</span><span id="line-155"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> @Override</span>
<span class="source-line-no">159</span><span id="line-159"> public PositionedByteRange putLong(int index, long val) {</span>
<span class="source-line-no">160</span><span id="line-160"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">164</span><span id="line-164"> public PositionedByteRange put(int index, byte[] val) {</span>
<span class="source-line-no">165</span><span id="line-165"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">166</span><span id="line-166"> }</span>
<span class="source-line-no">167</span><span id="line-167"></span>
<span class="source-line-no">168</span><span id="line-168"> @Override</span>
<span class="source-line-no">169</span><span id="line-169"> public PositionedByteRange put(int index, byte[] val, int offset, int length) {</span>
<span class="source-line-no">170</span><span id="line-170"> throw new ReadOnlyByteRangeException();</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"> @Override</span>
<span class="source-line-no">174</span><span id="line-174"> public PositionedByteRange deepCopy() {</span>
<span class="source-line-no">175</span><span id="line-175"> SimplePositionedByteRange clone = new SimplePositionedByteRange(deepCopyToNewArray());</span>
<span class="source-line-no">176</span><span id="line-176"> clone.position = this.position;</span>
<span class="source-line-no">177</span><span id="line-177"> return clone;</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> @Override</span>
<span class="source-line-no">181</span><span id="line-181"> public PositionedByteRange shallowCopy() {</span>
<span class="source-line-no">182</span><span id="line-182"> SimplePositionedByteRange clone = new SimplePositionedByteRange(bytes, offset, length);</span>
<span class="source-line-no">183</span><span id="line-183"> clone.position = this.position;</span>
<span class="source-line-no">184</span><span id="line-184"> return clone;</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> @Override</span>
<span class="source-line-no">188</span><span id="line-188"> public PositionedByteRange shallowCopySubRange(int innerOffset, int copyLength) {</span>
<span class="source-line-no">189</span><span id="line-189"> SimplePositionedByteRange clone =</span>
<span class="source-line-no">190</span><span id="line-190"> new SimplePositionedByteRange(bytes, offset + innerOffset, copyLength);</span>
<span class="source-line-no">191</span><span id="line-191"> clone.position = this.position;</span>
<span class="source-line-no">192</span><span id="line-192"> return clone;</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"> @Override</span>
<span class="source-line-no">196</span><span id="line-196"> public PositionedByteRange setLimit(int limit) {</span>
<span class="source-line-no">197</span><span id="line-197"> throw new ReadOnlyByteRangeException();</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> @Override</span>
<span class="source-line-no">201</span><span id="line-201"> public PositionedByteRange unset() {</span>
<span class="source-line-no">202</span><span id="line-202"> throw new ReadOnlyByteRangeException();</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">}</span>
</pre>
</div>
</main>
</body>
</html>