Package org.gnome.soup

Class ContentSniffer

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.ContentSniffer

All Implemented Interfaces:

Proxy, SessionFeature

@Generated("io.github.jwharm.JavaGI")
public final class ContentSniffer
extends GObject
implements SessionFeature

Sniffs the mime type of messages.

A SoupContentSniffer tries to detect the actual content type of the files that are being downloaded by looking at some of the data before the Message emits its Message::got-headers signal. SoupContentSniffer implements SessionFeature, so you can add content sniffing to a session with Session.addFeature(org.gnome.soup.SessionFeature) or Session.addFeatureByType(org.gnome.glib.Type).

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.soup.SessionFeature

SessionFeature.SessionFeatureImpl, SessionFeature.SessionFeatureInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ContentSniffer	asParent()	Returns this instance as if it were its parent type.
static ContentSniffer.Builder<? extends ContentSniffer.Builder>	builder()	A ContentSniffer.Builder object constructs a ContentSniffer with the specified properties.
static Type	getType()	Get the GType of the ContentSniffer class
String	sniff(Message msg, Bytes buffer, @Nullable Out<HashTable<String,String>> params)	Sniffs buffer to determine its Content-Type.

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, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.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 io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

ContentSniffer

public ContentSniffer(MemorySegment address)

Create a ContentSniffer proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ContentSniffer

public ContentSniffer()
               throws UnsupportedPlatformException

Creates a new SoupContentSniffer.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the ContentSniffer class

Returns:

the GType

asParent

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

sniff

public String sniff(Message msg,
 Bytes buffer,
 @Nullable
 @Nullable Out<HashTable<String,String>> params)

Sniffs buffer to determine its Content-Type.

The result may also be influenced by the Content-Type declared in msg's response headers.

Parameters:

msg - the message to sniff

buffer - a buffer containing the start of msg's response body

params - return location for Content-Type parameters (eg, "charset"), or null

Returns:

the sniffed Content-Type of buffer; this will never be null, but may be application/octet-stream.

builder

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

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