Package org.gnome.gio

Class FileInputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.FileInputStream

All Implemented Interfaces:

AutoCloseable, Seekable, Proxy, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public class FileInputStream
extends InputStream
implements Seekable

GFileInputStream provides input streams that take their content from a file.

GFileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, provided the filesystem of the file allows it. To find the position of a file input stream, use Seekable.tell(). To find out if a file input stream supports seeking, use Seekable.canSeek(). To position a file input stream, use Seekable.seek(long, org.gnome.glib.SeekType, org.gnome.gio.Cancellable).

Nested Class Summary

Nested Classes

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

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.Seekable

Seekable.Seekable$Impl, Seekable.SeekableIface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FileInputStream	asParent()	Returns this instance as if it were its parent type.
static FileInputStream.Builder<? extends FileInputStream.Builder>	builder()	A FileInputStream.Builder object constructs a FileInputStream with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the FileInputStream class
FileInfo	queryInfo(String attributes, @Nullable Cancellable cancellable)	Queries a file input stream the given attributes. This function blocks while querying the stream.
void	queryInfoAsync(String attributes, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Queries the stream information asynchronously.
FileInfo	queryInfoFinish(AsyncResult result)	Finishes an asynchronous info query operation.

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

handle

Methods inherited from interface org.gnome.gio.Seekable

canSeek, canTruncate, seek, tell, truncate

Constructor Details

FileInputStream

public FileInputStream(MemorySegment address)

Create a FileInputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileInputStream

public FileInputStream()

Creates a new FileInputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FileInputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected FileInputStream 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 InputStream

queryInfo

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

Queries a file input stream the given attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_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.

Parameters:

attributes - a file attribute query string.

cancellable - optional GCancellable object, null to ignore.

Returns:

a GFileInfo, or null on error.

Throws:

GErrorException - see GError

queryInfoAsync

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

Queries the stream information asynchronously. When the operation is finished callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation.

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

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

Parameters:

attributes - a file attribute query string.

ioPriority - the I/O priority of the request

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

queryInfoFinish

public FileInfo queryInfoFinish(AsyncResult result)
                         throws GErrorException

Finishes an asynchronous info query operation.

Parameters:

result - a GAsyncResult.

Returns:

GFileInfo.

Throws:

GErrorException - see GError

builder

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

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

Returns:

the builder object