aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java')
-rw-r--r--src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java110
1 files changed, 110 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
new file mode 100644
index 000000000..0deda7d0b
--- /dev/null
+++ b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
@@ -0,0 +1,110 @@
+/*
+ * 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 com.github.luben.zstd.ZstdOutputStream;
+import org.apache.commons.compress.compressors.CompressorOutputStream;
+
+/**
+ * {@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 {
+
+ private final ZstdOutputStream encOS;
+
+ /**
+ * 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
+ */
+ public ZstdCompressorOutputStream(final OutputStream outStream, int level, boolean closeFrameOnFlush,
+ boolean useChecksum) throws IOException {
+ this.encOS = new ZstdOutputStream(outStream, level, closeFrameOnFlush, useChecksum);
+ }
+
+ /**
+ * 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
+ */
+ public ZstdCompressorOutputStream(final OutputStream outStream, int level, boolean closeFrameOnFlush)
+ throws IOException {
+ this.encOS = new ZstdOutputStream(outStream, level, closeFrameOnFlush);
+ }
+
+ /**
+ * 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
+ */
+ public ZstdCompressorOutputStream(final OutputStream outStream, int level) throws IOException {
+ this.encOS = new ZstdOutputStream(outStream, level);
+ }
+
+ /**
+ * 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
+ */
+ public ZstdCompressorOutputStream(final OutputStream outStream) throws IOException {
+ this.encOS = new ZstdOutputStream(outStream);
+ }
+
+ @Override
+ public void close() throws IOException {
+ encOS.close();
+ }
+
+ @Override
+ public void write(final int b) throws IOException {
+ encOS.write(b);
+ }
+
+ @Override
+ public void write(final byte[] buf, final int off, final int len) throws IOException {
+ encOS.write(buf, off, len);
+ }
+
+ @Override
+ public String toString() {
+ return encOS.toString();
+ }
+
+ @Override
+ public void flush() throws IOException {
+ encOS.flush();
+ }
+}