Package org.gnome.gio

Class ConverterInputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.FilterInputStream

org.gnome.gio.ConverterInputStream

All Implemented Interfaces:

AutoCloseable, PollableInputStream, Proxy, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public class ConverterInputStream
extends FilterInputStream
implements PollableInputStream

Converter input stream implements InputStream and allows conversion of data of various types during reading.

As of GLib 2.34, GConverterInputStream implements PollableInputStream.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gio.FilterInputStream

FilterInputStream.FilterInputStream$Impl, FilterInputStream.FilterInputStreamClass

Nested classes/interfaces inherited from class org.gnome.gio.InputStream

InputStream.InputStream$Impl, InputStream.InputStreamClass

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

GObject.NotifyCallback, GObject.ObjectClass

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

PollableInputStream.PollableInputStream$Impl, PollableInputStream.PollableInputStreamInterface

Constructor Summary

Constructors

Constructor	Description
ConverterInputStream()	Creates a new ConverterInputStream.
ConverterInputStream(MemorySegment address)	Create a ConverterInputStream proxy instance for the provided memory address.
ConverterInputStream(InputStream baseStream, Converter converter)	Creates a new converter input stream for the baseStream.

Method Summary

Modifier and Type	Method	Description
protected ConverterInputStream	asParent()	Returns this instance as if it were its parent type.
static ConverterInputStream.Builder<? extends ConverterInputStream.Builder>	builder()	A ConverterInputStream.Builder object constructs a ConverterInputStream with the specified properties.
Converter	getConverter()	Gets the GConverter that is used by converterStream.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the ConverterInputStream class

Methods inherited from class org.gnome.gio.FilterInputStream

getBaseStream, getCloseBaseStream, setCloseBaseStream

Methods inherited from class org.gnome.gio.InputStream

clearPending, close, closeAsync, closeFinish, closeFn, hasPending, isClosed, read, readAll, readAllAsync, readAllFinish, readAsync, readBytes, readBytesAsync, readBytesFinish, readFinish, readFn, setPending, skip, skipAsync, skipFinish

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, 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.javagi.gio.AutoCloseable

close

Methods inherited from interface org.gnome.gio.PollableInputStream

canPoll, createSource, isReadable, readNonblocking

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ConverterInputStream

public ConverterInputStream(MemorySegment address)

Create a ConverterInputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ConverterInputStream

public ConverterInputStream(InputStream baseStream,
 Converter converter)

Creates a new converter input stream for the baseStream.

Parameters:

baseStream - a GInputStream

converter - a GConverter

ConverterInputStream

public ConverterInputStream()

Creates a new ConverterInputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ConverterInputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ConverterInputStream 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 FilterInputStream

getConverter

public Converter getConverter()

Gets the GConverter that is used by converterStream.

Returns:

the converter of the converter input stream

Since:

2.24

builder

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

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

Returns:

the builder object