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("org.javagi.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 OutputStream

OutputStream.OutputStream$Impl, OutputStream.OutputStreamClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FilterOutputStream	asParent()	Return 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 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 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Methods inherited from interface AutoCloseable

close

Constructor Details

FilterOutputStream

public FilterOutputStream(MemorySegment address)

Create a FilterOutputStream instance for the provided memory address.

Parameters:

address - the memory address of the native object

FilterOutputStream

public FilterOutputStream()

Create 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()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class OutputStream

Returns:

the instance as if it were its parent type

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.