Package org.gnome.gio

Class FileOutputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.OutputStream

org.gnome.gio.FileOutputStream

All Implemented Interfaces:

AutoCloseable, Seekable, Proxy, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public class FileOutputStream
extends OutputStream
implements Seekable

GFileOutputStream provides output streams that write their content to a file.

GFileOutputStream implements Seekable, which allows the output stream to jump to arbitrary positions in the file and to truncate the file, provided the filesystem of the file supports these operations.

To find the position of a file output stream, use Seekable.tell(). To find out if a file output stream supports seeking, use Seekable.canSeek().To position a file output stream, use Seekable.seek(long, org.gnome.glib.SeekType, org.gnome.gio.Cancellable). To find out if a file output stream supports truncating, use Seekable.canTruncate(). To truncate a file output stream, use Seekable.truncate(long, org.gnome.gio.Cancellable).

Nested Class Summary

Nested Classes

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

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

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

Seekable.Seekable$Impl, Seekable.SeekableIface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FileOutputStream	asParent()	Returns this instance as if it were its parent type.
static FileOutputStream.Builder<? extends FileOutputStream.Builder>	builder()	A FileOutputStream.Builder object constructs a FileOutputStream with the specified properties.
@Nullable String	getEtag()	Gets the entity tag for the file when it has been written.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the FileOutputStream class
FileInfo	queryInfo(String attributes, @Nullable Cancellable cancellable)	Queries a file output stream for the given attributes. This function blocks while querying the stream.
void	queryInfoAsync(String attributes, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously queries the this FileOutputStream for a GFileInfo.
FileInfo	queryInfoFinish(AsyncResult result)	Finalizes the asynchronous query started by g_file_output_stream_query_info_async().
protected boolean	truncateFn(long size, @Nullable Cancellable cancellable)

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, 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.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gio.Seekable

canSeek, canTruncate, seek, tell, truncate

Constructor Details

FileOutputStream

public FileOutputStream(MemorySegment address)

Create a FileOutputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileOutputStream

public FileOutputStream()

Creates a new FileOutputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FileOutputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getEtag

public @Nullable String getEtag()

Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing.

Returns:

the entity tag for the stream.

queryInfo

public FileInfo queryInfo(String attributes,
 @Nullable Cancellable cancellable)
                   throws GErrorException

Queries a file output stream for the given attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with IOErrorEnum.PENDING.

Can fail if the stream was already closed (with error being set to IOErrorEnum.CLOSED), the stream has pending operations (with error being set to IOErrorEnum.PENDING), or if querying info is not supported for the stream's interface (with error being set to IOErrorEnum.NOT_SUPPORTED). In all cases of failure, null will be returned.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnum.CANCELLED will be set, and null will be returned.

Parameters:

attributes - a file attribute query string.

cancellable - optional GCancellable object, null to ignore.

Returns:

a GFileInfo for the stream, or null on error.

Throws:

GErrorException - see GError

queryInfoAsync

public void queryInfoAsync(String attributes,
 int ioPriority,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Asynchronously queries the this FileOutputStream for a GFileInfo. When completed, callback will be called with a GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish().

For the synchronous version of this function, see g_file_output_stream_query_info().

Parameters:

attributes - a file attribute query string.

ioPriority - the I/O priority of the request

cancellable - optional GCancellable object, null to ignore.

callback - callback to call when the request is satisfied

queryInfoFinish

public FileInfo queryInfoFinish(AsyncResult result)
                         throws GErrorException

Finalizes the asynchronous query started by g_file_output_stream_query_info_async().

Parameters:

result - a GAsyncResult.

Returns:

A GFileInfo for the finished query.

Throws:

GErrorException - see GError

truncateFn

protected boolean truncateFn(long size,
 @Nullable Cancellable cancellable)
                      throws GErrorException

Throws:

GErrorException

builder

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

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

Returns:

the builder object