Package org.gnome.gio

Class Vfs

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.Vfs

All Implemented Interfaces:

Proxy

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

Entry point for using GIO functionality.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addWritableNamespaces(FileAttributeInfoList list)
protected Vfs	asParent()	Returns this instance as if it were its parent type.
static Vfs.Builder<? extends Vfs.Builder>	builder()	A Vfs.Builder object constructs a Vfs with the specified properties.
protected Icon	deserializeIcon(Variant value)
static Vfs	getDefault()	Gets the default GVfs for the system.
File	getFileForPath(String path)	Gets a GFile for path.
File	getFileForUri(String uri)	Gets a GFile for uri.
static Vfs	getLocal()	Gets the local GVfs for the system.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String[]	getSupportedUriSchemes()	Gets a list of URI schemes supported by vfs.
static @Nullable Type	getType()	Get the GType of the Vfs class
boolean	isActive()	Checks if the VFS is active.
protected void	localFileAddInfo(String filename, long device, FileAttributeMatcher attributeMatcher, FileInfo info, @Nullable Cancellable cancellable, @Nullable MemorySegment extraData)
protected void	localFileMoved(String source, String dest)
protected void	localFileRemoved(String filename)
protected boolean	localFileSetAttributes(String filename, FileInfo info, Set<FileQueryInfoFlags> flags, @Nullable Cancellable cancellable)
File	parseName(String parseName)	This operation never fails, but the returned object might not support any I/O operations if the parseName cannot be parsed by the GVfs module.
boolean	registerUriScheme(String scheme, @Nullable VfsFileLookupFunc uriFunc, @Nullable VfsFileLookupFunc parseNameFunc)	Registers uriFunc and parseNameFunc as the GFile URI and parse name lookup functions for URIs with a scheme matching scheme. Note that scheme is registered only within the running application, as opposed to desktop-wide as it happens with GVfs backends.
boolean	unregisterUriScheme(String scheme)	Unregisters the URI handler for scheme previously registered with g_vfs_register_uri_scheme().

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

Constructor Details

Vfs

public Vfs(MemorySegment address)

Create a Vfs proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Vfs

public Vfs()

Creates a new Vfs.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Vfs class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getDefault

public static Vfs getDefault()

Gets the default GVfs for the system.

Returns:

a GVfs, which will be the local file system GVfs if no other implementation is available.

getLocal

public static Vfs getLocal()

Gets the local GVfs for the system.

Returns:

a GVfs.

getFileForPath

public File getFileForPath(String path)

Gets a GFile for path.

Parameters:

path - a string containing a VFS path.

Returns:

a GFile. Free the returned object with g_object_unref().

getFileForUri

public File getFileForUri(String uri)

Gets a GFile for uri.

This operation never fails, but the returned object might not support any I/O operation if the URI is malformed or if the URI scheme is not supported.

Parameters:

uri - a string containing a URI

Returns:

a GFile. Free the returned object with g_object_unref().

getSupportedUriSchemes

public String[] getSupportedUriSchemes()

Gets a list of URI schemes supported by vfs.

Returns:

a null-terminated array of strings. The returned array belongs to GIO and must not be freed or modified.

isActive

public boolean isActive()

Checks if the VFS is active.

Returns:

true if construction of the this Vfs was successful and it is now active.

parseName

public File parseName(String parseName)

This operation never fails, but the returned object might not support any I/O operations if the parseName cannot be parsed by the GVfs module.

Parameters:

parseName - a string to be parsed by the VFS module.

Returns:

a GFile for the given parseName. Free the returned object with g_object_unref().

registerUriScheme

public boolean registerUriScheme(String scheme,
 @Nullable VfsFileLookupFunc uriFunc,
 @Nullable VfsFileLookupFunc parseNameFunc)

Registers uriFunc and parseNameFunc as the GFile URI and parse name lookup functions for URIs with a scheme matching scheme. Note that scheme is registered only within the running application, as opposed to desktop-wide as it happens with GVfs backends.

When a GFile is requested with an URI containing scheme (e.g. through g_file_new_for_uri()), uriFunc will be called to allow a custom constructor. The implementation of uriFunc should not be blocking, and must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().

When g_file_parse_name() is called with a parse name obtained from such file, parseNameFunc will be called to allow the GFile to be created again. In that case, it's responsibility of parseNameFunc to make sure the parse name matches what the custom GFile implementation returned when g_file_get_parse_name() was previously called. The implementation of parseNameFunc should not be blocking, and must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().

It's an error to call this function twice with the same scheme. To unregister a custom URI scheme, use g_vfs_unregister_uri_scheme().

Parameters:

scheme - an URI scheme, e.g. "http"

uriFunc - a GVfsFileLookupFunc

parseNameFunc - a GVfsFileLookupFunc

Returns:

true if scheme was successfully registered, or false if a handler for scheme already exists.

Since:

2.50

unregisterUriScheme

public boolean unregisterUriScheme(String scheme)

Unregisters the URI handler for scheme previously registered with g_vfs_register_uri_scheme().

Parameters:

scheme - an URI scheme, e.g. "http"

Returns:

true if scheme was successfully unregistered, or false if a handler for scheme does not exist.

Since:

2.50

addWritableNamespaces

protected void addWritableNamespaces(FileAttributeInfoList list)

deserializeIcon

protected Icon deserializeIcon(Variant value)

localFileAddInfo

protected void localFileAddInfo(String filename,
 long device,
 FileAttributeMatcher attributeMatcher,
 FileInfo info,
 @Nullable Cancellable cancellable,
 @Nullable MemorySegment extraData)

localFileMoved

protected void localFileMoved(String source,
 String dest)

localFileRemoved

protected void localFileRemoved(String filename)

localFileSetAttributes

protected boolean localFileSetAttributes(String filename,
 FileInfo info,
 Set<FileQueryInfoFlags> flags,
 @Nullable Cancellable cancellable)
                                  throws GErrorException

Throws:

GErrorException

builder

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

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

Returns:

the builder object