zstd-jni 1.5.5-11 · com.github.luben.zstd.ZstdDirectBufferCompressingStream

Modifier and Type	Field and Description
private boolean	finalize
pack-priv ZstdDirectBufferCompressingStreamNoFinalizer	inner

Access	Constructor and Description
public	ZstdDirectBufferCompressingStream(ByteBuffer target, int level)

Method Summary

Modifier and Type	Method and Description
public synchronized void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public synchronized void	compress(ByteBuffer source)
protected void	finalize() Overrides java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
public synchronized void	flush() Implements java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream.
protected ByteBuffer	Returns: the new buffer to use, for most cases the same as the one passed in, after a call to `ByteBuffer#clear()`. flushBuffer(ByteBuffer buffer that has to be flushed (or most cases, you want to call `ByteBuffer#flip()` first) toFlush) This method should flush the buffer and either return the same buffer (but cleared) or a new buffer that should be used from then on.
public static int	recommendedOutputBufferSize()
public synchronized ZstdDirectBufferCompressingStream	setDict(byte[] dict)
public synchronized ZstdDirectBufferCompressingStream	setDict(ZstdDictCompress dict)
public void	setFinalize(boolean default `true` - finalizers are enabled finalize) Enable or disable class finalizers If finalizers are disabled the responsibility fir calling the `close` method is on the consumer.

Inherited from java.lang.Object:: clone equals getClass hashCode notify notifyAll toString wait wait wait

finalize	back to summary
private boolean finalize

inner	back to summary
pack-priv ZstdDirectBufferCompressingStreamNoFinalizer inner

ZstdDirectBufferCompressingStream	back to summary
public ZstdDirectBufferCompressingStream(ByteBuffer target, int level) throws IOException

Method Detail

close back to summary

close	back to summary
public synchronized void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public synchronized void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

compress	back to summary
public synchronized void compress(ByteBuffer source) throws IOException

finalize back to summary

finalize	back to summary
protected void finalize() throws Throwable Overrides java.lang.Object.finalize. Doc from java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call `finalize()`. In a Java virtual machine in which finalization is enabled, the garbage collector might call `finalize` only after an indefinite delay. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored. Annotations @Override Exceptions Throwable: the `Exception` raised by this method

protected void finalize() throws Throwable

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations

@Override

Exceptions

Throwable:: the Exception raised by this method

flush	back to summary
public synchronized void flush() throws IOException Implements java.io.Flushable.flush. Doc from java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public synchronized void flush() throws IOException

Implements java.io.Flushable.flush.

Doc from java.io.Flushable.flush.

Flushes this stream by writing any buffered output to the underlying stream.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

flushBuffer back to summary

flushBuffer	back to summary
protected ByteBuffer flushBuffer(ByteBuffer toFlush) throws IOException This method should flush the buffer and either return the same buffer (but cleared) or a new buffer that should be used from then on. Parameters toFlush:ByteBuffer buffer that has to be flushed (or most cases, you want to call `ByteBuffer#flip()` first) Returns:ByteBuffer the new buffer to use, for most cases the same as the one passed in, after a call to `ByteBuffer#clear()`.

protected ByteBuffer flushBuffer(ByteBuffer toFlush) throws IOException

This method should flush the buffer and either return the same buffer (but cleared) or a new buffer that should be used from then on.

Parameters

toFlush:ByteBuffer: buffer that has to be flushed (or most cases, you want to call ByteBuffer#flip() first)

Returns:ByteBuffer

the new buffer to use, for most cases the same as the one passed in, after a call to ByteBuffer#clear().

recommendedOutputBufferSize	back to summary
public static int recommendedOutputBufferSize()

setDict	back to summary
public synchronized ZstdDirectBufferCompressingStream setDict(byte[] dict) throws IOException

setDict	back to summary
public synchronized ZstdDirectBufferCompressingStream setDict(ZstdDictCompress dict) throws IOException

setFinalize	back to summary
public void setFinalize(boolean finalize) Enable or disable class finalizers If finalizers are disabled the responsibility fir calling the `close` method is on the consumer. Parameters finalize:boolean default `true` - finalizers are enabled

setFinalize

back to summary

public void setFinalize(boolean finalize)

Enable or disable class finalizers If finalizers are disabled the responsibility fir calling the `close` method is on the consumer.

Parameters

finalize:boolean: default `true` - finalizers are enabled

public Class ZstdDirectBufferCompressingStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail