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 * https://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.OutputStream;
22
23 import org.apache.commons.compress.CompressFilterOutputStream;
24
25 /**
26 * Abstracts all classes that compress an output stream.
27 *
28 * @param <T> The underlying {@link OutputStream} type.
29 */
30 public abstract class CompressorOutputStream<T extends OutputStream> extends CompressFilterOutputStream<T> {
31
32 /**
33 * Constructs a new instance without a backing {@link OutputStream}.
34 * <p>
35 * You must initialize {@code this.out} after construction.
36 * </p>
37 */
38 public CompressorOutputStream() {
39 // empty
40 }
41
42 /**
43 * Creates an output stream filter built on top of the specified underlying {@link OutputStream}.
44 *
45 * @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
46 * without an underlying stream.
47 * @since 1.27.0
48 */
49 public CompressorOutputStream(final T out) {
50 super(out);
51 }
52
53 }