Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.zstandard.ZstdCompressorOutputStream

Modifier and Type	Field and Description
private final ZstdOutputStream	encOS

Constructor Summary

Access	Constructor and Description
public	ZstdCompressorOutputStream(final OutputStream the stream to write to outStream) Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for `level`, `closeFrameOnFlush` and `useChecksum`.
public	ZstdCompressorOutputStream(final OutputStream the stream to write to outStream, final int value for zstd-jni's level argument level) Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for `closeFrameOnFlush` and `useChecksum`.
public	ZstdCompressorOutputStream(final OutputStream the stream to write to outStream, final int value for zstd-jni's level argument level, final boolean value for zstd-jni's closeFrameOnFlush argument closeFrameOnFlush) Wraps the given stream into a zstd-jni ZstdOutputStream using the default value for `useChecksum`.
public	ZstdCompressorOutputStream(final OutputStream the stream to write to outStream, final int value for zstd-jni's level argument level, final boolean value for zstd-jni's closeFrameOnFlush argument closeFrameOnFlush, final boolean value for zstd-jni's useChecksum argument useChecksum) Wraps the given stream into a zstd-jni ZstdOutputStream.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(final byte[] the data. buf, final int the start offset in the data. off, final int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Field Detail

encOS	back to summary
private final ZstdOutputStream encOS

Constructor Detail

ZstdCompressorOutputStream back to summary

ZstdCompressorOutputStream	back to summary
public ZstdCompressorOutputStream(final OutputStream outStream) throws IOException Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for `level`, `closeFrameOnFlush` and `useChecksum`. Parameters outStream:OutputStream the stream to write to Exceptions IOException: if zstd-jni does

public ZstdCompressorOutputStream(final OutputStream outStream) throws IOException

Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for level, closeFrameOnFlush and useChecksum.

Parameters

outStream:OutputStream: the stream to write to

Exceptions

IOException:: if zstd-jni does

ZstdCompressorOutputStream back to summary

ZstdCompressorOutputStream	back to summary
public ZstdCompressorOutputStream(final OutputStream outStream, final int level) throws IOException Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for `closeFrameOnFlush` and `useChecksum`. Parameters outStream:OutputStream the stream to write to level:int value for zstd-jni's level argument Exceptions IOException: if zstd-jni does Since 1.18

public ZstdCompressorOutputStream(final OutputStream outStream, final int level) throws IOException

Wraps the given stream into a zstd-jni ZstdOutputStream using the default values for closeFrameOnFlush and useChecksum.

Parameters

outStream:OutputStream: the stream to write to
level:int: value for zstd-jni's level argument

Exceptions

IOException:: if zstd-jni does

Since

1.18

ZstdCompressorOutputStream back to summary

ZstdCompressorOutputStream	back to summary
public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush) throws IOException Wraps the given stream into a zstd-jni ZstdOutputStream using the default value for `useChecksum`. Parameters outStream:OutputStream the stream to write to level:int value for zstd-jni's level argument closeFrameOnFlush:boolean value for zstd-jni's closeFrameOnFlush argument Exceptions IOException: if zstd-jni does Since 1.18

public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush) throws IOException

Wraps the given stream into a zstd-jni ZstdOutputStream using the default value for useChecksum.

Parameters

outStream:OutputStream: the stream to write to
level:int: value for zstd-jni's level argument
closeFrameOnFlush:boolean: value for zstd-jni's closeFrameOnFlush argument

Exceptions

IOException:: if zstd-jni does

Since

1.18

ZstdCompressorOutputStream	back to summary
public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush, final boolean useChecksum) throws IOException Wraps the given stream into a zstd-jni ZstdOutputStream. Parameters outStream:OutputStream the stream to write to level:int value for zstd-jni's level argument closeFrameOnFlush:boolean value for zstd-jni's closeFrameOnFlush argument useChecksum:boolean value for zstd-jni's useChecksum argument Exceptions IOException: if zstd-jni does Since 1.18

ZstdCompressorOutputStream

back to summary

public ZstdCompressorOutputStream(final OutputStream outStream, final int level, final boolean closeFrameOnFlush, final boolean useChecksum) throws IOException

Wraps the given stream into a zstd-jni ZstdOutputStream.

Parameters

outStream:OutputStream: the stream to write to
level:int: value for zstd-jni's level argument
closeFrameOnFlush:boolean: value for zstd-jni's closeFrameOnFlush argument
useChecksum:boolean: value for zstd-jni's useChecksum argument

Exceptions

IOException:: if zstd-jni does

Since

1.18

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

write back to summary

write	back to summary
public void write(final byte[] buf, final int off, final int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters buf:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(final byte[] buf, final int off, final int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

buf:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write back to summary

write	back to summary
public void write(final int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

public Class ZstdCompressorOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail