    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 * http://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.deflate;
    020
    021import java.io.IOException;
    022import java.io.OutputStream;
    023import java.util.zip.Deflater;
    024import java.util.zip.DeflaterOutputStream;
    025
    026import org.apache.commons.compress.compressors.CompressorOutputStream;
    027
    028/**
    029 * Deflate compressor.
    030 * @since 1.9
    031 */
    032public class DeflateCompressorOutputStream extends CompressorOutputStream {
    033    private final DeflaterOutputStream out;
    034    private final Deflater deflater;
    035
    036    /**
    037     * Creates a Deflate compressed output stream with the default parameters.
    038     * @param outputStream the stream to wrap
    039     */
    040    public DeflateCompressorOutputStream(final OutputStream outputStream) {
    041        this(outputStream, new DeflateParameters());
    042    }
    043
    044    /**
    045     * Creates a Deflate compressed output stream with the specified parameters.
    046     * @param outputStream the stream to wrap
    047     * @param parameters the deflate parameters to apply
    048     */
    049    public DeflateCompressorOutputStream(final OutputStream outputStream,
    050                                         final DeflateParameters parameters) {
    051        this.deflater = new Deflater(parameters.getCompressionLevel(), !parameters.withZlibHeader());
    052        this.out = new DeflaterOutputStream(outputStream, deflater);
    053    }
    054
    055    @Override
    056    public void close() throws IOException {
    057        try {
    058            out.close();
    059        } finally {
    060            deflater.end();
    061        }
    062    }
    063
    064    /**
    065     * Finishes compression without closing the underlying stream.
    066     * <p>No more data can be written to this stream after finishing.</p>
    067     * @throws IOException on error
    068     */
    069    public void finish() throws IOException {
    070        out.finish();
    071    }
    072
    073    /**
    074     * Flushes the encoder and calls {@code outputStream.flush()}.
    075     * All buffered pending data will then be decompressible from
    076     * the output stream. Calling this function very often may increase
    077     * the compressed file size a lot.
    078     */
    079    @Override
    080    public void flush() throws IOException {
    081        out.flush();
    082    }
    083
    084    @Override
    085    public void write(final byte[] buf, final int off, final int len) throws IOException {
    086        out.write(buf, off, len);
    087    }
    088
    089    @Override
    090    public void write(final int b) throws IOException {
    091        out.write(b);
    092    }
    093}