Package org.gnome.gio

Class ZlibCompressor

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.ZlibCompressor

All Implemented Interfaces:

Converter, Proxy

@Generated("io.github.jwharm.JavaGI")
public class ZlibCompressor
extends GObject
implements Converter

GZlibCompressor is an implementation of Converter that compresses data using zlib.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZlibCompressor.Builder<B extends ZlibCompressor.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ZlibCompressor.ZlibCompressorClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.Converter

Converter.Converter$Impl, Converter.ConverterIface

Constructor Summary

Constructors

Constructor	Description
ZlibCompressor()	Creates a new ZlibCompressor.
ZlibCompressor(MemorySegment address)	Create a ZlibCompressor proxy instance for the provided memory address.
ZlibCompressor(ZlibCompressorFormat format, int level)	Creates a compressor.

Method Summary

Modifier and Type	Method	Description
protected ZlibCompressor	asParent()	Returns this instance as if it were its parent type.
static ZlibCompressor.Builder<? extends ZlibCompressor.Builder>	builder()	A ZlibCompressor.Builder object constructs a ZlibCompressor with the specified properties.
@Nullable FileInfo	getFileInfo()	Gets the Gio.ZlibCompressor:file-info property.
int	getOs()	Gets the Gio.ZlibCompressor:os property.
static @Nullable Type	getType()	Get the GType of the ZlibCompressor class
void	setFileInfo(@Nullable FileInfo fileInfo)	Sets the Gio.ZlibCompressor:file-info property.
void	setOs(int os)	Sets the Gio.ZlibCompressor:os property.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gio.Converter

convert, convert, convertBytes, reset

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ZlibCompressor

public ZlibCompressor(MemorySegment address)

Create a ZlibCompressor proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ZlibCompressor

public ZlibCompressor(ZlibCompressorFormat format,
 int level)

Creates a compressor.

Parameters:

format - the format to use for the compressed data

level - compression level (0-9), -1 for default

Since:

2.24

ZlibCompressor

public ZlibCompressor()

Creates a new ZlibCompressor.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ZlibCompressor class

Returns:

the GType

asParent

protected ZlibCompressor asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getFileInfo

public @Nullable FileInfo getFileInfo()

Gets the Gio.ZlibCompressor:file-info property.

Returns:

file info for the gzip header, if set

Since:

2.26

getOs

public int getOs()

Gets the Gio.ZlibCompressor:os property.

Returns:

the previously set OS value, or -1 if unset

Since:

2.86

setFileInfo

public void setFileInfo(@Nullable FileInfo fileInfo)

Sets the Gio.ZlibCompressor:file-info property.

Note: it is an error to call this function while a compression is in progress; it may only be called immediately after creation of compressor, or after resetting it with Converter.reset().

Parameters:

fileInfo - file info for the gzip header

Since:

2.26

setOs

public void setOs(int os)

Sets the Gio.ZlibCompressor:os property.

Note: it is an error to call this function while a compression is in progress; it may only be called immediately after creation of compressor, or after resetting it with Converter.reset().

Parameters:

os - the OS code to use, or -1 to unset

Since:

2.86

builder

public static ZlibCompressor.Builder<? extends ZlibCompressor.Builder> builder()

A ZlibCompressor.Builder object constructs a ZlibCompressor with the specified properties. Use the various set...() methods to set properties, and finish construction with ZlibCompressor.Builder.build().

Returns:

the builder object