Package org.gnome.gdk

Class ContentSerializer

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdk.ContentSerializer

All Implemented Interfaces:

AsyncResult, Proxy

@Generated("io.github.jwharm.JavaGI")
public class ContentSerializer
extends GObject
implements AsyncResult

Serializes content for inter-application data transfers.

The GdkContentSerializer transforms an object that is identified by a GType into a serialized form (i.e. a byte stream) that is identified by a mime type.

GTK provides serializers and deserializers for common data types such as text, colors, images or file lists. To register your own serialization functions, use Gdk.contentRegisterSerializer(org.gnome.glib.Type, java.lang.String, org.gnome.gdk.ContentSerializeFunc).

Also see ContentDeserializer.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

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

AsyncResult.AsyncResult$Impl, AsyncResult.AsyncResultIface

Constructor Summary

Constructors

Constructor	Description
ContentSerializer()	Creates a new ContentSerializer.
ContentSerializer(MemorySegment address)	Create a ContentSerializer proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ContentSerializer	asParent()	Returns this instance as if it were its parent type.
static ContentSerializer.Builder<? extends ContentSerializer.Builder>	builder()	A ContentSerializer.Builder object constructs a ContentSerializer with the specified properties.
@Nullable Cancellable	getCancellable()	Gets the cancellable for the current operation.
Type	getGtype()	Gets the GType to of the object to serialize.
String	getMimeType()	Gets the mime type to serialize to.
OutputStream	getOutputStream()	Gets the output stream for the current operation.
int	getPriority()	Gets the I/O priority for the current operation.
@Nullable MemorySegment	getTaskData()	Gets the data that was associated with the current operation.
static @Nullable Type	getType()	Get the GType of the ContentSerializer class
@Nullable MemorySegment	getUserData()	Gets the user data that was passed when the serializer was registered.
Value	getValue()	Gets the GValue to read the object to serialize from.
void	returnError(GError error)	Indicate that the serialization has ended with an error.
void	returnSuccess()	Indicate that the serialization has been successfully completed.
void	setTaskData(@Nullable MemorySegment data)	Associate data with the current serialization operation.

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.AsyncResult

getSourceObject, isTagged, legacyPropagateError

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ContentSerializer

public ContentSerializer(MemorySegment address)

Create a ContentSerializer proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ContentSerializer

public ContentSerializer()

Creates a new ContentSerializer.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ContentSerializer class

Returns:

the GType

asParent

protected ContentSerializer 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

getCancellable

public @Nullable Cancellable getCancellable()

Gets the cancellable for the current operation.

This is the GCancellable that was passed to Gdk.contentSerializeAsync(org.gnome.gio.OutputStream, java.lang.String, org.gnome.gobject.Value, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Returns:

the cancellable for the current operation

getGtype

public Type getGtype()

Gets the GType to of the object to serialize.

Returns:

the GType for the current operation

getMimeType

public String getMimeType()

Gets the mime type to serialize to.

Returns:

the mime type for the current operation

getOutputStream

public OutputStream getOutputStream()

Gets the output stream for the current operation.

This is the stream that was passed to Gdk.contentSerializeAsync(org.gnome.gio.OutputStream, java.lang.String, org.gnome.gobject.Value, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Returns:

the output stream for the current operation

getPriority

public int getPriority()

Gets the I/O priority for the current operation.

This is the priority that was passed to Gdk.contentSerializeAsync(org.gnome.gio.OutputStream, java.lang.String, org.gnome.gobject.Value, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Returns:

the I/O priority for the current operation

getTaskData

public @Nullable MemorySegment getTaskData()

Gets the data that was associated with the current operation.

See setTaskData(java.lang.foreign.MemorySegment).

Returns:

the task data for this ContentSerializer

getUserData

public @Nullable MemorySegment getUserData()

Gets the user data that was passed when the serializer was registered.

Specified by:

getUserData in interface AsyncResult

Returns:

the user data for this serializer

getValue

public Value getValue()

Gets the GValue to read the object to serialize from.

Returns:

the GValue for the current operation

returnError

public void returnError(GError error)

Indicate that the serialization has ended with an error.

This function consumes error.

Parameters:

error - a GError

returnSuccess

public void returnSuccess()

Indicate that the serialization has been successfully completed.

setTaskData

public void setTaskData(@Nullable MemorySegment data)

Associate data with the current serialization operation.

Parameters:

data - data to associate with this operation

builder

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

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

Returns:

the builder object