Class VirtualFileSystem

java.lang.Object

org.graalvm.python.embedding.VirtualFileSystem

All Implemented Interfaces:

AutoCloseable

public final class VirtualFileSystem
extends Object
implements AutoCloseable

The GraalPy Virtual Filesystem accesses embedded resource files as standard Java resources and makes them available to Python code running in GraalPy.

Since:

24.2.0

See Also:

• for more information on Python resources in GraalPy embedding and how to use the VirtualFileSystem together with a GraalPy context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VirtualFileSystem.Builder	Builder class to create VirtualFileSystem instances.
static enum	VirtualFileSystem.HostIO	Determines if and how much host IO is allowed outside the VirtualFileSystem.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the VirtualFileSystem and frees up potentially allocated resources.
static VirtualFileSystem	create()	Creates a VirtualFileSystem with default configuration.
String	getMountPoint()	Returns the mount point for this VirtualFileSystem.
static VirtualFileSystem.Builder	newBuilder()	Creates a builder for constructing a VirtualFileSystem with a custom configuration.

Methods inherited from class Object

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

Method Details

newBuilder

public static VirtualFileSystem.Builder newBuilder()

Creates a builder for constructing a VirtualFileSystem with a custom configuration.

Returns:

new VirtualFileSystem.Builder instance

Since:

24.2.0

create

public static VirtualFileSystem create()

Creates a VirtualFileSystem with default configuration. Use newBuilder() to customize the configuration.

Returns:

new VirtualFileSystem instance

Since:

24.2.0

getMountPoint

public String getMountPoint()

Returns the mount point for this VirtualFileSystem.

Returns:

the mount point

Since:

24.2.0

See Also:

• VirtualFileSystem.Builder.windowsMountPoint(String)
• VirtualFileSystem.Builder.unixMountPoint(String)

close

public void close()
           throws IOException

Closes the VirtualFileSystem and frees up potentially allocated resources.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if the resources could not be freed.