001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.compress.compressors.zstandard;
019
020
021import java.io.IOException;
022import java.io.OutputStream;
023
024import com.github.luben.zstd.ZstdOutputStream;
025import org.apache.commons.compress.compressors.CompressorOutputStream;
026
027/**
028 * {@link CompressorOutputStream} implementation to create Zstandard encoded stream.
029 * Library relies on <a href="https://github.com/luben/zstd-jni/">Zstandard JNI</a>
030 *
031 * @since 1.16
032 */
033public class ZstdCompressorOutputStream extends CompressorOutputStream {
034
035    private final ZstdOutputStream encOS;
036
037    /**
038     * Wraps the given stream into a zstd-jni ZstdOutputStream.
039     * @param outStream the stream to write to
040     * @param level value for zstd-jni's level argument
041     * @param closeFrameOnFlush value for zstd-jni's closeFrameOnFlush argument
042     * @param useChecksum value for zstd-jni's useChecksum argument
043     * @throws IOException if zstd-jni does
044     * @since 1.18
045     */
046    public ZstdCompressorOutputStream(final OutputStream outStream, int level, boolean closeFrameOnFlush,
047        boolean useChecksum) throws IOException {
048        this.encOS = new ZstdOutputStream(outStream, level, closeFrameOnFlush, useChecksum);
049    }
050
051    /**
052     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default value for {@code useChecksum}.
053     * @param outStream the stream to write to
054     * @param level value for zstd-jni's level argument
055     * @param closeFrameOnFlush value for zstd-jni's closeFrameOnFlush argument
056     * @throws IOException if zstd-jni does
057     * @since 1.18
058     */
059    public ZstdCompressorOutputStream(final OutputStream outStream, int level, boolean closeFrameOnFlush)
060        throws IOException {
061        this.encOS = new ZstdOutputStream(outStream, level, closeFrameOnFlush);
062    }
063
064    /**
065     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for {@code closeFrameOnFlush}
066     * and {@code useChecksum}.
067     * @param outStream the stream to write to
068     * @param level value for zstd-jni's level argument
069     * @throws IOException if zstd-jni does
070     * @since 1.18
071     */
072    public ZstdCompressorOutputStream(final OutputStream outStream, int level) throws IOException {
073        this.encOS = new ZstdOutputStream(outStream, level);
074    }
075
076    /**
077     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for {@code level}, {@code
078     * closeFrameOnFlush} and {@code useChecksum}.
079     * @param outStream the stream to write to
080     * @throws IOException if zstd-jni does
081     */
082    public ZstdCompressorOutputStream(final OutputStream outStream) throws IOException {
083        this.encOS = new ZstdOutputStream(outStream);
084    }
085
086    @Override
087    public void close() throws IOException {
088        encOS.close();
089    }
090
091    @Override
092    public void write(final int b) throws IOException {
093        encOS.write(b);
094    }
095
096    @Override
097    public void write(final byte[] buf, final int off, final int len) throws IOException {
098        encOS.write(buf, off, len);
099    }
100
101    @Override
102    public String toString() {
103        return encOS.toString();
104    }
105
106    @Override
107    public void flush() throws IOException {
108        encOS.flush();
109    }
110}