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,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.compress.compressors;
20
21 import java.io.FilterOutputStream;
22 import java.io.OutputStream;
23
24 /**
25 * Abstracts all classes that compress an output stream.
26 *
27 * @param <T> The underlying OutputStream type.
28 */
29 public abstract class CompressorOutputStream<T extends OutputStream> extends FilterOutputStream {
30
31 /**
32 * Constructs a new instance without a backing OutputStream.
33 * <p>
34 * You must initialize {@code this.out} after construction.
35 * </p>
36 */
37 public CompressorOutputStream() {
38 super(null);
39 }
40
41 /**
42 * Creates an output stream filter built on top of the specified underlying output stream.
43 *
44 * @param out the underlying output stream to be assigned to the field {@code this.out} for later use, or {@code null} if this instance is to be created
45 * without an underlying stream.
46 * @since 1.27.0
47 */
48 public CompressorOutputStream(final T out) {
49 super(out);
50 }
51
52 /**
53 * Gets the underlying output stream.
54 *
55 * @return the underlying output stream.
56 * @since 1.27.0
57 */
58 @SuppressWarnings("unchecked")
59 protected T out() {
60 return (T) out;
61 }
62 }