ZstdCompressorOutputStream.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.compress.compressors.zstandard;

import java.io.IOException;
import java.io.OutputStream;

import org.apache.commons.compress.compressors.CompressorOutputStream;

import com.github.luben.zstd.ZstdOutputStream;

/**
 * {@link CompressorOutputStream} implementation to create Zstandard encoded stream. Library relies on <a href="https://github.com/luben/zstd-jni/">Zstandard
 * JNI</a>
 *
 * @since 1.16
 */
public class ZstdCompressorOutputStream extends CompressorOutputStream<ZstdOutputStream> {

    /**
     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for {@code level}, {@code
     * closeFrameOnFlush} and {@code useChecksum}.
     *
     * @param outStream the stream to write to
     * @throws IOException if zstd-jni does
     */
    @SuppressWarnings("resource") // Caller closes
    public ZstdCompressorOutputStream(final OutputStream outStream) throws IOException {
        super(new ZstdOutputStream(outStream));
    }

    /**
     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for {@code closeFrameOnFlush} and {@code useChecksum}.
     *
     * @param outStream the stream to write to
     * @param level     value for zstd-jni's level argument
     * @throws IOException if zstd-jni does
     * @since 1.18
     */
    @SuppressWarnings("resource") // Caller closes
    public ZstdCompressorOutputStream(final OutputStream outStream, final int level) throws IOException {
        super(new ZstdOutputStream(outStream, level));
    }

    /**
     * Wraps the given stream into a zstd-jni ZstdOutputStream using the default value for {@code useChecksum}.
     *
     * @param outStream         the stream to write to
     * @param level             value for zstd-jni's level argument
     * @param closeFrameOnFlush value for zstd-jni's closeFrameOnFlush argument
     * @throws IOException if zstd-jni does
     * @since 1.18
     */
    @SuppressWarnings("resource") // Caller closes
    public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush) throws IOException {
        super(new ZstdOutputStream(outStream, level));
        out().setCloseFrameOnFlush(closeFrameOnFlush);
    }

    /**
     * Wraps the given stream into a zstd-jni ZstdOutputStream.
     *
     * @param outStream         the stream to write to
     * @param level             value for zstd-jni's level argument
     * @param closeFrameOnFlush value for zstd-jni's closeFrameOnFlush argument
     * @param useChecksum       value for zstd-jni's useChecksum argument
     * @throws IOException if zstd-jni does
     * @since 1.18
     */
    @SuppressWarnings("resource") // Caller closes
    public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush, final boolean useChecksum)
            throws IOException {
        super(new ZstdOutputStream(outStream, level));
        out()
            .setCloseFrameOnFlush(closeFrameOnFlush)
            .setChecksum(useChecksum);
    }

    @Override
    public String toString() {
        return out.toString();
    }

    @Override
    public void write(final byte[] buf, final int off, final int len) throws IOException {
        out.write(buf, off, len);
    }

}