org.graalvm.compiler.debug

Class PathUtilities

java.lang.Object

org.graalvm.compiler.debug.PathUtilities

public class PathUtilities
extends Object

Miscellaneous methods for modifying and generating file system paths. All path arguments and return values are Strings to avoid use of File and Path which may not be supported in all environments in which Graal is embedded. Use in such environments requires defining a PathUtilitiesProvider service implementation.

Constructor Summary

Constructors

Constructor and Description
PathUtilities()

Method Summary

Modifier and Type	Method and Description
static String	archiveAndDelete(String directory, String zip) Zips and deletes directory if it exists.
static String	createDirectories(String path) Creates a directory represented by path by creating all nonexistent parent directories first.
static void	deleteFile(String path) Deletes the file or directory denoted by path.
static boolean	exists(String path) Tests whether the file or directory denoted by path exists.
static String	getAbsolutePath(String path) Gets the absolute pathname of path.
static String	getParent(String path) Gets the pathname of path's parent, or null if path does not have a parent directory.
static String	getPath(String first, String... more) Joins a sequence of strings to form a pathname.
static boolean	isDirectory(String path, boolean followLinks)
static WritableByteChannel	openFileChannel(String path, OpenOption... options) Opens or creates a file, returning a channel to access the file path.
static InputStream	openInputStream(String path) Creates an input stream by opening the file path.
static OutputStream	openOutputStream(String path) Short cut for calling PathUtilities.openOutputStream(String, boolean) with the arguments path and false.
static OutputStream	openOutputStream(String path, boolean append) Creates an output stream to write to the file path.
static String	sanitizeFileName(String name) Gets a value based on name that can be passed to PathUtilities.getPath(String, String...) without causing an InvalidPathException.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathUtilities

public PathUtilities()

Method Detail

sanitizeFileName

public static String sanitizeFileName(String name)

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

Returns:

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

getPath

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

Joins a sequence of strings to form a pathname.

getAbsolutePath

public static String getAbsolutePath(String path)

Gets the absolute pathname of path.

exists

public static boolean exists(String path)

Tests whether the file or directory denoted by path exists.

createDirectories

public static String createDirectories(String path)
                                throws IOException

Creates a directory represented by path by creating all nonexistent parent directories first. An exception is not thrown if the directory could not be created because it already exists. If this method fails, then it may do so after creating some, but not all, of the parent directories.

Throws:

IOException - if path exists but is not a directory or if some I/O error occurs

openOutputStream

public static OutputStream openOutputStream(String path,
                                            boolean append)
                                     throws IOException

Creates an output stream to write to the file path. If append is true, then bytes will be written to the end of the file rather than the beginning. throws IOException if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

Throws:

IOException

openOutputStream

public static OutputStream openOutputStream(String path)
                                     throws IOException

Short cut for calling PathUtilities.openOutputStream(String, boolean) with the arguments path and false.

Throws:

IOException

getParent

public static String getParent(String path)

Gets the pathname of path's parent, or null if path does not have a parent directory.

openFileChannel

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

Opens or creates a file, returning a channel to access the file path.

Throws:

IOException

openInputStream

public static InputStream openInputStream(String path)
                                   throws IOException

Creates an input stream by opening the file path.

Throws:

IOException - if path does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading

archiveAndDelete

public static 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

isDirectory

public static boolean isDirectory(String path,
                                  boolean followLinks)

deleteFile

public static void deleteFile(String path)
                       throws IOException

Deletes the file or directory denoted by path. If path denotes a directory, then it must be empty in order to be deleted.

Throws:

IOException - if the deletion fails