Top Description Inners Constructors Methods
com.aayushatharva.brotli4j.encoder

public Class EncoderJNI

extends Object
Class Inheritance
Annotations
@Upstream
Imports
com.aayushatharva.brotli4j.common.annotations.Upstream, java.io.IOException, java.nio.ByteBuffer

JNI wrapper for brotli encoder.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
private static class
public static class

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private static native boolean
nativeAttachDictionary(long[] context, ByteBuffer dictionary)

private static native ByteBuffer
nativeCreate(long[] context)

private static native void
nativeDestroy(long[] context)

private static native void
private static native ByteBuffer
nativePrepareDictionary(ByteBuffer dictionary, long type)

private static native ByteBuffer
nativePull(long[] context)

private static native void
nativePush(long[] context, int length)

pack-priv static PreparedDictionary
prepareDictionary(ByteBuffer
raw / serialized dictionary data; MUST be direct
dictionary
,
int
dictionary data type
sharedDictionaryType
)

Prepares raw or serialized dictionary for being used by encoder.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

EncoderJNIback to summary
public EncoderJNI()

Method Detail

nativeAttachDictionaryback to summary
private static native boolean nativeAttachDictionary(long[] context, ByteBuffer dictionary)
nativeCreateback to summary
private static native ByteBuffer nativeCreate(long[] context)
nativeDestroyback to summary
private static native void nativeDestroy(long[] context)
nativeDestroyDictionaryback to summary
private static native void nativeDestroyDictionary(ByteBuffer dictionary)
nativePrepareDictionaryback to summary
private static native ByteBuffer nativePrepareDictionary(ByteBuffer dictionary, long type)
nativePullback to summary
private static native ByteBuffer nativePull(long[] context)
nativePushback to summary
private static native void nativePush(long[] context, int length)
prepareDictionaryback to summary
pack-priv static PreparedDictionary prepareDictionary(ByteBuffer dictionary, int sharedDictionaryType)

Prepares raw or serialized dictionary for being used by encoder.

Parameters
dictionary:ByteBuffer

raw / serialized dictionary data; MUST be direct

sharedDictionaryType:int

dictionary data type

com.aayushatharva.brotli4j.encoder back to summary

pack-priv final Enum EncoderJNI.Operation

extends Enum<EncoderJNI.Operation>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final EncoderJNI.Operation
public static final EncoderJNI.Operation
public static final EncoderJNI.Operation

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static EncoderJNI.Operation
public static EncoderJNI.Operation[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FINISHback to summary
public static final EncoderJNI.Operation FINISH
FLUSHback to summary
public static final EncoderJNI.Operation FLUSH
PROCESSback to summary
public static final EncoderJNI.Operation PROCESS

Constructor Detail

Operationback to summary
private Operation()

Method Detail

valueOfback to summary
public static EncoderJNI.Operation valueOf(String name)
valuesback to summary
public static EncoderJNI.Operation[] values()
com.aayushatharva.brotli4j.encoder back to summary

private Class EncoderJNI.PreparedDictionaryImpl

extends Object
implements PreparedDictionary
Class Inheritance
  • java.lang.Object
  • com.aayushatharva.brotli4j.encoder.EncoderJNI.PreparedDictionaryImpl
All Implemented Interfaces
com.aayushatharva.brotli4j.encoder.PreparedDictionary

Field Summary

Modifier and TypeField and Description
private ByteBuffer
private ByteBuffer
rawData

Reference to (non-copied) LZ data.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
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 ByteBuffer
Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

databack to summary
private ByteBuffer data
rawDataback to summary
private ByteBuffer rawData

Reference to (non-copied) LZ data.

Constructor Detail

PreparedDictionaryImplback to summary
private PreparedDictionaryImpl(ByteBuffer data, ByteBuffer rawData)

Method Detail

finalizeback 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
getDataback to summary
public ByteBuffer getData()

Implements com.aayushatharva.brotli4j.encoder.PreparedDictionary.getData.

Annotations
@Override
com.aayushatharva.brotli4j.encoder back to summary

public Class EncoderJNI.Wrapper

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
protected final long[]
private boolean
private final ByteBuffer

Constructor Summary

AccessConstructor and Description
public
Wrapper(int inputBufferSize, int quality, int lgwin, Encoder.Mode mode)

Method Summary

Modifier and TypeMethod and Description
public boolean
public void
destroy()

Releases native resources.

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 ByteBuffer
public boolean
public boolean
public boolean
public boolean
public ByteBuffer
pull()

public void
push(EncoderJNI.Operation op, int length)

Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

contextback to summary
protected final long[] context
freshback to summary
private boolean fresh
inputBufferback to summary
private final ByteBuffer inputBuffer

Constructor Detail

Wrapperback to summary
public Wrapper(int inputBufferSize, int quality, int lgwin, Encoder.Mode mode) throws IOException

Method Detail

attachDictionaryback to summary
public boolean attachDictionary(ByteBuffer dictionary)
destroyback to summary
public void destroy()

Releases native resources.

finalizeback 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
getInputBufferback to summary
public ByteBuffer getInputBuffer()
hasMoreOutputback to summary
public boolean hasMoreOutput()
hasRemainingInputback to summary
public boolean hasRemainingInput()
isFinishedback to summary
public boolean isFinished()
isSuccessback to summary
public boolean isSuccess()
pullback to summary
public ByteBuffer pull()
pushback to summary
public void push(EncoderJNI.Operation op, int length)