org.graalvm.compiler.debug

Interface PathUtilitiesProvider

All Known Implementing Classes:

StandardPathUtilitiesProvider

public interface PathUtilitiesProvider

Defines a service for accessing storage resembling a file system. This exists for Graal embedders in an environment where a standard file system is not available. An implementation of this service is loaded via ServiceLoader which means the implementation class must be named in a META-INF/services/org.graalvm.compiler.debug.PathUtilitiesProvider service description file accessible on the class path. Note that a PathUtilitiesProvider implementation must work in the context of building a native image as well as in the context of the resulting native image. Delegating to StandardPathUtilitiesProvider is the recommended way to work in the context of building a native image.

Method Summary

Modifier and Type	Method and Description
String	archiveAndDelete(String directory, String zip) Zips and deletes directory if it exists.
String	createDirectories(String path)
String	createFile(String path)
void	deleteFile(String path)
boolean	exists(String path)
String	getAbsolutePath(String path)
String	getParent(String path)
String	getPath(String first, String... more)
boolean	isDirectory(String path, boolean followLinks)
WritableByteChannel	openFileChannel(String path, OpenOption... options)
InputStream	openInputStream(String path)
OutputStream	openOutputStream(String path, boolean append)
String	sanitizeFileName(String name) Gets a value based on name that can be passed to PathUtilitiesProvider.getPath(String, String...) without causing an InvalidPathException.

Method Detail

sanitizeFileName

String sanitizeFileName(String name)

Gets a value based on name that can be passed to PathUtilitiesProvider.getPath(String, String...) without causing an InvalidPathException.

Returns:

name with all characters invalid for the current file system replaced by '_'

archiveAndDelete

String archiveAndDelete(String directory,
                        String zip)
                 throws IOException

Zips and deletes directory if it exists.

Parameters:

zip - path of the zip file to create

Throws:

IOException - if something goes wrong

getPath

String getPath(String first,
               String... more)

See Also:

Paths.get(String, String...)

getAbsolutePath

String getAbsolutePath(String path)

See Also:

File.getAbsolutePath()

openOutputStream

OutputStream openOutputStream(String path,
                              boolean append)
                       throws IOException

Throws:

IOException

See Also:

FileOutputStream.FileOutputStream(String, boolean)

exists

boolean exists(String path)

See Also:

File.exists()

createDirectories

String createDirectories(String path)
                  throws IOException

Throws:

IOException

See Also:

Files.createDirectories(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)

createFile

String createFile(String path)
           throws IOException

Throws:

IOException

See Also:

Files.createFile(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)

isDirectory

boolean isDirectory(String path,
                    boolean followLinks)

See Also:

Files.isDirectory(java.nio.file.Path, java.nio.file.LinkOption...)

deleteFile

void deleteFile(String path)
         throws IOException

Throws:

IOException

See Also:

Files.delete(Path)

getParent

String getParent(String path)

See Also:

File.getParent()

openFileChannel

WritableByteChannel openFileChannel(String path,
                                    OpenOption... options)
                             throws IOException

Throws:

IOException

See Also:

FileChannel.open(Path, OpenOption...)

openInputStream

InputStream openInputStream(String path)
                     throws IOException

Throws:

IOException

See Also:

FileInputStream.FileInputStream(String)