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.OutputStream; |
---|
23 | |
---|
24 | /** |
---|
25 | * A compression output stream. |
---|
26 | */ |
---|
27 | public abstract class CompressionOutputStream extends OutputStream { |
---|
28 | /** |
---|
29 | * The output stream to be compressed. |
---|
30 | */ |
---|
31 | protected final OutputStream out; |
---|
32 | |
---|
33 | /** |
---|
34 | * Create a compression output stream that writes |
---|
35 | * the compressed bytes to the given stream. |
---|
36 | * @param out |
---|
37 | */ |
---|
38 | protected CompressionOutputStream(OutputStream out) { |
---|
39 | this.out = out; |
---|
40 | } |
---|
41 | |
---|
42 | public void close() throws IOException { |
---|
43 | finish(); |
---|
44 | out.close(); |
---|
45 | } |
---|
46 | |
---|
47 | public void flush() throws IOException { |
---|
48 | out.flush(); |
---|
49 | } |
---|
50 | |
---|
51 | /** |
---|
52 | * Write compressed bytes to the stream. |
---|
53 | * Made abstract to prevent leakage to underlying stream. |
---|
54 | */ |
---|
55 | public abstract void write(byte[] b, int off, int len) throws IOException; |
---|
56 | |
---|
57 | /** |
---|
58 | * Finishes writing compressed data to the output stream |
---|
59 | * without closing the underlying stream. |
---|
60 | */ |
---|
61 | public abstract void finish() throws IOException; |
---|
62 | |
---|
63 | /** |
---|
64 | * Reset the compression to the initial state. |
---|
65 | * Does not reset the underlying stream. |
---|
66 | */ |
---|
67 | public abstract void resetState() throws IOException; |
---|
68 | |
---|
69 | } |
---|