001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * https://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.commons.compress.compressors; 020 021import java.io.OutputStream; 022 023import org.apache.commons.compress.CompressFilterOutputStream; 024 025/** 026 * Abstracts all classes that compress an output stream. 027 * 028 * @param <T> The underlying {@link OutputStream} type. 029 */ 030public abstract class CompressorOutputStream<T extends OutputStream> extends CompressFilterOutputStream<T> { 031 032 /** 033 * Constructs a new instance without a backing {@link OutputStream}. 034 * <p> 035 * You must initialize {@code this.out} after construction. 036 * </p> 037 */ 038 public CompressorOutputStream() { 039 // empty 040 } 041 042 /** 043 * Creates an output stream filter built on top of the specified underlying {@link OutputStream}. 044 * 045 * @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 046 * without an underlying stream. 047 * @since 1.27.0 048 */ 049 public CompressorOutputStream(final T out) { 050 super(out); 051 } 052 053}