org.apache.hadoop.hbase.io.DelegatingInputStream Maven / Gradle / Ivy
Show all versions of hbase-common Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hbase.io;
import java.io.FilterInputStream;
import java.io.InputStream;
import org.apache.yetus.audience.InterfaceAudience;
/**
* An input stream that delegates all operations to another input stream. The delegate can be
* switched out for another at any time but to minimize the possibility of violating the InputStream
* contract it would be best to replace the delegate only once it has been fully consumed.
*
* For example, a ByteArrayInputStream, which is implicitly bounded by the size of the underlying
* byte array can be converted into an unbounded stream fed by multiple instances of
* ByteArrayInputStream, switched out one for the other in sequence.
*
* Although multithreaded access is allowed, users of this class will want to take care to order
* operations on this stream and the swap out of one delegate for another in a way that provides a
* valid view of stream contents.
*/
@InterfaceAudience.Private
public class DelegatingInputStream extends FilterInputStream {
public DelegatingInputStream(InputStream in) {
super(in);
}
public InputStream getDelegate() {
return this.in;
}
public void setDelegate(InputStream in) {
this.in = in;
}
}