Package org.gnome.gtksourceview

Class FileLoader

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.FileLoader

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class FileLoader
extends GObject

Load a file into a GtkSourceBuffer.

A GtkSourceFileLoader object permits to load the contents of a File or a InputStream into a Buffer.

A file loader should be used only for one load operation, including errors handling. If an error occurs, you can reconfigure the loader and relaunch the operation with loadAsync(int, org.gnome.gio.Cancellable, org.gnome.gio.FileProgressCallback, org.gnome.gio.AsyncReadyCallback).

Running a GtkSourceFileLoader is an undoable action for the Buffer.

After a file loading, the buffer is reset to the contents provided by the File or InputStream, so the buffer is set as “unmodified”, that is, TextBuffer.setModified(boolean) is called with false. If the contents isn't saved somewhere (for example if you load from stdin), then you should probably call TextBuffer.setModified(boolean) with true after calling loadFinish(org.gnome.gio.AsyncResult).

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
FileLoader(MemorySegment address)	Create a FileLoader proxy instance for the provided memory address.
FileLoader(Buffer buffer, File file)	Creates a new GtkSourceFileLoader object.

Method Summary

Modifier and Type	Method	Description
protected FileLoader	asParent()	Returns this instance as if it were its parent type.
static FileLoader.Builder<? extends FileLoader.Builder>	builder()	A FileLoader.Builder object constructs a FileLoader with the specified properties.
static FileLoader	fromStream(Buffer buffer, File file, InputStream stream)	Creates a new GtkSourceFileLoader object.
Buffer	getBuffer()
CompressionType	getCompressionType()
Encoding	getEncoding()
File	getFile()
InputStream	getInputStream()
File	getLocation()
NewlineType	getNewlineType()
static Type	getType()	Get the GType of the FileLoader class
void	loadAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable FileProgressCallback progressCallback, @Nullable AsyncReadyCallback callback)	Loads asynchronously the file or input stream contents into the Buffer.
boolean	loadFinish(AsyncResult result)	Finishes a file loading started with loadAsync(int, org.gnome.gio.Cancellable, org.gnome.gio.FileProgressCallback, org.gnome.gio.AsyncReadyCallback).
void	setCandidateEncodings(SList<Encoding> candidateEncodings)	Sets the candidate encodings for the file loading.

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, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

FileLoader

public FileLoader(MemorySegment address)

Create a FileLoader proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileLoader

public FileLoader(Buffer buffer,
 File file)

Creates a new GtkSourceFileLoader object. The contents is read from the File's location.

If not already done, call File.setLocation(org.gnome.gio.File) before calling this constructor. The previous location is anyway not needed, because as soon as the file loading begins, the buffer is emptied.

Parameters:

buffer - the GtkSourceBuffer to load the contents into.

file - the GtkSourceFile.

Method Details

getType

public static Type getType()

Get the GType of the FileLoader class

Returns:

the GType

asParent

protected FileLoader 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 GObject

fromStream

public static FileLoader fromStream(Buffer buffer,
 File file,
 InputStream stream)

Creates a new GtkSourceFileLoader object. The contents is read from stream.

Parameters:

buffer - the GtkSourceBuffer to load the contents into.

file - the GtkSourceFile.

stream - the GInputStream to load, e.g. stdin.

Returns:

a new GtkSourceFileLoader object.

getBuffer

public Buffer getBuffer()

getCompressionType

public CompressionType getCompressionType()

getEncoding

public Encoding getEncoding()

getFile

public File getFile()

getInputStream

public InputStream getInputStream()

getLocation

public File getLocation()

getNewlineType

public NewlineType getNewlineType()

loadAsync

public void loadAsync(int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable FileProgressCallback progressCallback,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Loads asynchronously the file or input stream contents into the Buffer.

See the AsyncResult documentation to know how to use this function.

Parameters:

ioPriority - the I/O priority of the request. E.g. G_PRIORITY_LOW, G_PRIORITY_DEFAULT or G_PRIORITY_HIGH.

cancellable - optional GCancellable object, null to ignore.

progressCallback - function to call back with progress information, or null if progress information is not needed.

callback - a GAsyncReadyCallback to call when the request is satisfied.

loadFinish

public boolean loadFinish(AsyncResult result)
                   throws GErrorException

Finishes a file loading started with loadAsync(int, org.gnome.gio.Cancellable, org.gnome.gio.FileProgressCallback, org.gnome.gio.AsyncReadyCallback).

If the contents has been loaded, the following File properties will be updated: the location, the encoding, the newline type and the compression type.

Parameters:

result - a GAsyncResult.

Returns:

whether the contents has been loaded successfully.

Throws:

GErrorException - see GError

setCandidateEncodings

public void setCandidateEncodings(SList<Encoding> candidateEncodings)

Sets the candidate encodings for the file loading.

The encodings are tried in the same order as the list.

For convenience, candidateEncodings can contain duplicates. Only the first occurrence of a duplicated encoding is kept in the list.

By default the candidate encodings are (in that order in the list):

1. If set, the File's encoding as returned by File.getEncoding(). 2. The default candidates as returned by Encoding.getDefaultCandidates().

Parameters:

candidateEncodings - a list of GtkSourceEncoding<!-- -->s.

builder

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

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