blob: b842bb0a83f205bf61ee4f62ad11a326b642bcf5 [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.io, class: DelegatingInputStream">
<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 java.io.FilterInputStream;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.InputStream;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">/**</span>
<span class="source-line-no">025</span><span id="line-25"> * An input stream that delegates all operations to another input stream. The delegate can be</span>
<span class="source-line-no">026</span><span id="line-26"> * switched out for another at any time but to minimize the possibility of violating the InputStream</span>
<span class="source-line-no">027</span><span id="line-27"> * contract it would be best to replace the delegate only once it has been fully consumed.</span>
<span class="source-line-no">028</span><span id="line-28"> * &lt;p&gt;</span>
<span class="source-line-no">029</span><span id="line-29"> * For example, a ByteArrayInputStream, which is implicitly bounded by the size of the underlying</span>
<span class="source-line-no">030</span><span id="line-30"> * byte array can be converted into an unbounded stream fed by multiple instances of</span>
<span class="source-line-no">031</span><span id="line-31"> * ByteArrayInputStream, switched out one for the other in sequence.</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;p&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * Although multithreaded access is allowed, users of this class will want to take care to order</span>
<span class="source-line-no">034</span><span id="line-34"> * operations on this stream and the swap out of one delegate for another in a way that provides a</span>
<span class="source-line-no">035</span><span id="line-35"> * valid view of stream contents.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">public class DelegatingInputStream extends FilterInputStream {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> public DelegatingInputStream(InputStream in) {</span>
<span class="source-line-no">041</span><span id="line-41"> super(in);</span>
<span class="source-line-no">042</span><span id="line-42"> }</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> public InputStream getDelegate() {</span>
<span class="source-line-no">045</span><span id="line-45"> return this.in;</span>
<span class="source-line-no">046</span><span id="line-46"> }</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> public void setDelegate(InputStream in) {</span>
<span class="source-line-no">049</span><span id="line-49"> this.in = in;</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">}</span>
</pre>
</div>
</main>
</body>
</html>