Package org.gnome.gio

Class FilterOutputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.OutputStream

org.gnome.gio.FilterOutputStream

All Implemented Interfaces:

AutoCloseable, Proxy, AutoCloseable

Direct Known Subclasses:

BufferedOutputStream, ConverterOutputStream, DataOutputStream, FilterOutputStream.FilterOutputStream$Impl

@Generated("io.github.jwharm.JavaGI")
public abstract class FilterOutputStream
extends OutputStream

Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterOutputStream.Builder<B extends FilterOutputStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FilterOutputStream.FilterOutputStream$Impl	The FilterOutputStream$Impl type represents a native instance of the abstract FilterOutputStream class.
static class	FilterOutputStream.FilterOutputStreamClass

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

OutputStream.OutputStream$Impl, OutputStream.OutputStreamClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FilterOutputStream	asParent()	Returns this instance as if it were its parent type.
OutputStream	getBaseStream()	Gets the base stream for the filter stream.
boolean	getCloseBaseStream()	Returns whether the base stream will be closed when this FilterOutputStream is closed.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the FilterOutputStream class
void	setCloseBaseStream(boolean closeBase)	Sets whether the base stream will be closed when this FilterOutputStream is closed.

Methods inherited from class org.gnome.gio.OutputStream

clearPending, close, closeAsync, closeFinish, closeFn, flush, flushAsync, flushFinish, hasPending, isClosed, isClosing, printf, setPending, splice, splice, spliceAsync, spliceAsync, spliceFinish, write, writeAll, writeAllAsync, writeAllFinish, writeAsync, writeBytes, writeBytesAsync, writeBytesFinish, writeFinish, writev, writevAll, writevAllAsync, writevAllFinish, writevAsync, writevFinish

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, builder, 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

Constructor Details

FilterOutputStream

public FilterOutputStream(MemorySegment address)

Create a FilterOutputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FilterOutputStream

public FilterOutputStream()

Creates a new FilterOutputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FilterOutputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected FilterOutputStream 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 OutputStream

getBaseStream

public OutputStream getBaseStream()

Gets the base stream for the filter stream.

Returns:

a OutputStream.

getCloseBaseStream

public boolean getCloseBaseStream()

Returns whether the base stream will be closed when this FilterOutputStream is closed.

Returns:

TRUE if the base stream will be closed.

setCloseBaseStream

public void setCloseBaseStream(boolean closeBase)

Sets whether the base stream will be closed when this FilterOutputStream is closed.

Parameters:

closeBase - TRUE to close the base stream.