[120] | 1 | /* |
---|
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
---|
| 3 | * or more contributor license agreements. See the NOTICE file |
---|
| 4 | * distributed with this work for additional information |
---|
| 5 | * regarding copyright ownership. The ASF licenses this file |
---|
| 6 | * to you under the Apache License, Version 2.0 (the |
---|
| 7 | * "License"); you may not use this file except in compliance |
---|
| 8 | * with the License. You may obtain a copy of the License at |
---|
| 9 | * |
---|
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
---|
| 11 | * |
---|
| 12 | * Unless required by applicable law or agreed to in writing, software |
---|
| 13 | * distributed under the License is distributed on an "AS IS" BASIS, |
---|
| 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
| 15 | * See the License for the specific language governing permissions and |
---|
| 16 | * limitations under the License. |
---|
| 17 | */ |
---|
| 18 | |
---|
| 19 | package org.apache.hadoop.io.compress; |
---|
| 20 | |
---|
| 21 | import java.io.IOException; |
---|
| 22 | import java.io.InputStream; |
---|
| 23 | |
---|
| 24 | /** |
---|
| 25 | * A compression input stream. |
---|
| 26 | * |
---|
| 27 | * <p>Implementations are assumed to be buffered. This permits clients to |
---|
| 28 | * reposition the underlying input stream then call {@link #resetState()}, |
---|
| 29 | * without having to also synchronize client buffers. |
---|
| 30 | */ |
---|
| 31 | public abstract class CompressionInputStream extends InputStream { |
---|
| 32 | /** |
---|
| 33 | * The input stream to be compressed. |
---|
| 34 | */ |
---|
| 35 | protected final InputStream in; |
---|
| 36 | |
---|
| 37 | /** |
---|
| 38 | * Create a compression input stream that reads |
---|
| 39 | * the decompressed bytes from the given stream. |
---|
| 40 | * |
---|
| 41 | * @param in The input stream to be compressed. |
---|
| 42 | */ |
---|
| 43 | protected CompressionInputStream(InputStream in) { |
---|
| 44 | this.in = in; |
---|
| 45 | } |
---|
| 46 | |
---|
| 47 | public void close() throws IOException { |
---|
| 48 | in.close(); |
---|
| 49 | } |
---|
| 50 | |
---|
| 51 | /** |
---|
| 52 | * Read bytes from the stream. |
---|
| 53 | * Made abstract to prevent leakage to underlying stream. |
---|
| 54 | */ |
---|
| 55 | public abstract int read(byte[] b, int off, int len) throws IOException; |
---|
| 56 | |
---|
| 57 | /** |
---|
| 58 | * Reset the decompressor to its initial state and discard any buffered data, |
---|
| 59 | * as the underlying stream may have been repositioned. |
---|
| 60 | */ |
---|
| 61 | public abstract void resetState() throws IOException; |
---|
| 62 | |
---|
| 63 | } |
---|