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   
035    /**
036     * Creates a Deflate compressed output stream with the default parameters.
037     */
038    public DeflateCompressorOutputStream(OutputStream outputStream) throws IOException {
039        this(outputStream, new DeflateParameters());
040    }
041
042    /**
043     * Creates a Deflate compressed output stream with the specified parameters.
044     */
045    public DeflateCompressorOutputStream(OutputStream outputStream,
046                                         DeflateParameters parameters) throws IOException {
047        this.out = new DeflaterOutputStream(outputStream, new Deflater(parameters.getCompressionLevel(), !parameters.withZlibHeader()));
048    }
049
050    @Override
051    public void write(int b) throws IOException {
052        out.write(b);
053    }
054
055    @Override
056    public void write(byte[] buf, int off, int len) throws IOException {
057        out.write(buf, off, len);
058    }
059
060    /**
061     * Flushes the encoder and calls <code>outputStream.flush()</code>.
062     * All buffered pending data will then be decompressible from
063     * the output stream. Calling this function very often may increase
064     * the compressed file size a lot.
065     */
066    @Override
067    public void flush() throws IOException {
068        out.flush();
069    }
070
071    /**
072     * Finishes compression without closing the underlying stream.
073     * No more data can be written to this stream after finishing.
074     */
075    public void finish() throws IOException {
076        out.finish();
077    }
078
079    @Override
080    public void close() throws IOException {
081        out.close();
082    }
083}