org.graalvm.polyglot.io

Interface FileSystem

public interface FileSystem

Service-provider for Truffle files.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	checkAccess(Path path, Set<? extends AccessMode> modes, LinkOption... linkOptions) Checks existence and accessibility of a file.
default void	copy(Path source, Path target, CopyOption... options) Copies source file to target file.
void	createDirectory(Path dir, FileAttribute<?>... attrs) Creates a directory.
default void	createLink(Path link, Path existing) Creates a new link for an existing file.
default void	createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs) Creates a new symbolic link.
void	delete(Path path) Deletes a file.
default String	getSeparator() Returns the name separator used to separate names in a path string.
default void	move(Path source, Path target, CopyOption... options) Moves (renames) source file to target file.
SeekableByteChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) Opens or creates a file returning a SeekableByteChannel to access the file content.
DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) Returns directory entries.
Path	parsePath(String path) Parses a path from a String.
Path	parsePath(URI uri) Parses a path from an URI.
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) Reads a file's attributes as a bulk operation.
default Path	readSymbolicLink(Path link) Reads the target of the symbolic link.
default void	setAttribute(Path path, String attribute, Object value, LinkOption... options) Sets a file's attribute.
default void	setCurrentWorkingDirectory(Path currentWorkingDirectory) Sets the current working directory.
Path	toAbsolutePath(Path path) Resolves given path to an absolute path.
Path	toRealPath(Path path, LinkOption... linkOptions) Returns the real (canonical) path of an existing file.

Method Detail

parsePath

Path parsePath(URI uri)

Parses a path from an URI.

Parameters:

uri - the URI to be converted to Path

Returns:

the Path representing given URI

Throws:

UnsupportedOperationException - when URI scheme is not supported

Since:

1.0

parsePath

Path parsePath(String path)

Parses a path from a String. This method is called only on the FileSystem with file scheme.

Parameters:

path - the string path to be converted to Path

Returns:

the Path

Throws:

UnsupportedOperationException - when the FileSystem supports only URI

Since:

1.0

checkAccess

void checkAccess(Path path,
                 Set<? extends AccessMode> modes,
                 LinkOption... linkOptions)
          throws IOException

Checks existence and accessibility of a file.

Parameters:

path - the path to the file to check

modes - the access modes to check, possibly empty to check existence only.

linkOptions - options determining how the symbolic links should be handled

Throws:

NoSuchFileException - if the file denoted by the path does not exist

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

createDirectory

void createDirectory(Path dir,
                     FileAttribute<?>... attrs)
              throws IOException

Creates a directory.

Parameters:

dir - the directory to create

attrs - the optional attributes to set atomically when creating the directory

Throws:

FileAlreadyExistsException - if a file on given path already exists

IOException - in case of IO error

UnsupportedOperationException - if the attributes contain an attribute which cannot be set atomically

SecurityException - if this FileSystem denied the operation

Since:

1.0

delete

void delete(Path path)
     throws IOException

Deletes a file.

Parameters:

path - the path to the file to delete

Throws:

NoSuchFileException - if a file on given path does not exist

DirectoryNotEmptyException - if the path denotes a non empty directory

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

newByteChannel

SeekableByteChannel newByteChannel(Path path,
                                   Set<? extends OpenOption> options,
                                   FileAttribute<?>... attrs)
                            throws IOException

Opens or creates a file returning a SeekableByteChannel to access the file content.

Parameters:

path - the path to the file to open

options - the options specifying how the file should be opened

attrs - the optional attributes to set atomically when creating the new file

Returns:

the created SeekableByteChannel

Throws:

FileAlreadyExistsException - if StandardOpenOption.CREATE_NEW option is set and a file already exists on given path

IOException - in case of IO error

UnsupportedOperationException - if the attributes contain an attribute which cannot be set atomically

IllegalArgumentException - in case of invalid options combination

SecurityException - if this FileSystem denied the operation

Since:

1.0

newDirectoryStream

DirectoryStream<Path> newDirectoryStream(Path dir,
                                         DirectoryStream.Filter<? super Path> filter)
                                  throws IOException

Returns directory entries.

Parameters:

dir - the path to the directory to iterate entries for

filter - the filter

Returns:

the new DirectoryStream

Throws:

NotDirectoryException - when given path does not denote a directory

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

toAbsolutePath

Path toAbsolutePath(Path path)

Resolves given path to an absolute path.

Parameters:

path - the path to resolve, may be a non normalized path

Returns:

an absolute Path

Throws:

SecurityException - if this FileSystem denied the operation

Since:

1.0

toRealPath

Path toRealPath(Path path,
                LinkOption... linkOptions)
         throws IOException

Returns the real (canonical) path of an existing file.

Parameters:

path - the path to resolve, may be a non normalized path

linkOptions - options determining how the symbolic links should be handled

Returns:

an absolute canonical path

Throws:

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

readAttributes

Map<String,Object> readAttributes(Path path,
                                  String attributes,
                                  LinkOption... options)
                           throws IOException

Reads a file's attributes as a bulk operation.

Parameters:

path - the path to file to read attributes for

attributes - the attributes to read. The attributes parameter has the form: [view-name:]attribute-list. The optional view-name corresponds to AttributeView.name() and determines the set of attributes, the default value is "basic". The attribute-list is a comma separated list of attributes. If the attribute-list contains '*' then all the attributes from given view are read.

options - the options determining how the symbolic links should be handled

Returns:

the Map containing the file attributes. The map's keys are attribute names, map's values are the attribute values

Throws:

UnsupportedOperationException - if the attribute view is not supported. At least the "basic" attribute view has to be supported by the file system.

IllegalArgumentException - is the attribute-list is empty or contains an unknown attribute

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

setAttribute

default void setAttribute(Path path,
                          String attribute,
                          Object value,
                          LinkOption... options)
                   throws IOException

Sets a file's attribute.

Parameters:

path - the path to file to set an attribute to

attribute - the attribute to set. The attribute parameter has the form: [view-name:]attribute-name. The optional view-name corresponds to AttributeView.name() and determines the set of attributes, the default value is "basic". The attribute-name is a name of an attribute.

value - the attribute value

options - the options determining how the symbolic links should be handled

Throws:

ClassCastException - if value is not of the expected type or value is a Collection containing element of a non expected type

UnsupportedOperationException - if the attribute view is not supported.

IllegalArgumentException - is the attribute-name is an unknown attribute or value has an inappropriate value

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

copy

default void copy(Path source,
                  Path target,
                  CopyOption... options)
           throws IOException

Copies source file to target file.

Parameters:

source - the path to file to copy

target - the path to the target file

options - the options specifying how the copy should be performed, see StandardCopyOption

Throws:

UnsupportedOperationException - if options contains unsupported option

FileAlreadyExistsException - if the target path already exists and the options don't contain StandardCopyOption.REPLACE_EXISTING option

DirectoryNotEmptyException - if the options contain StandardCopyOption.REPLACE_EXISTING but the target is a non empty directory

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

move

default void move(Path source,
                  Path target,
                  CopyOption... options)
           throws IOException

Moves (renames) source file to target file.

Parameters:

source - the path to file to move

target - the path to the target file

options - the options specifying how the move should be performed, see StandardCopyOption

Throws:

UnsupportedOperationException - if options contains unsupported option

FileAlreadyExistsException - if the target path already exists and the options don't contain StandardCopyOption.REPLACE_EXISTING option

DirectoryNotEmptyException - if the options contain StandardCopyOption.REPLACE_EXISTING but the target is a non empty directory

AtomicMoveNotSupportedException - if the options contain StandardCopyOption.ATOMIC_MOVE but file cannot be moved atomically

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

createLink

default void createLink(Path link,
                        Path existing)
                 throws IOException

Creates a new link for an existing file.

Parameters:

link - the path to link to create

existing - the path to existing file

Throws:

UnsupportedOperationException - if links are not supported by file system

FileAlreadyExistsException - if a file on given link path already exists

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

createSymbolicLink

default void createSymbolicLink(Path link,
                                Path target,
                                FileAttribute<?>... attrs)
                         throws IOException

Creates a new symbolic link.

Parameters:

link - the path to symbolic link to create

target - the target path of the symbolic link

attrs - the optional attributes to set atomically when creating the new symbolic link

Throws:

UnsupportedOperationException - if symbolic links are not supported by file system

FileAlreadyExistsException - if a file on given link path already exists

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

readSymbolicLink

default Path readSymbolicLink(Path link)
                       throws IOException

Reads the target of the symbolic link.

Parameters:

link - the path to symbolic link to read

Returns:

the Path representing the symbolic link target

Throws:

UnsupportedOperationException - if symbolic links are not supported by file system

NotLinkException - if the link does not denote a symbolic link

IOException - in case of IO error

SecurityException - if this FileSystem denied the operation

Since:

1.0

setCurrentWorkingDirectory

default void setCurrentWorkingDirectory(Path currentWorkingDirectory)

Sets the current working directory. The current working directory is used to resolve non absolute paths in FileSystem operations.

Parameters:

currentWorkingDirectory - the new current working directory

Throws:

UnsupportedOperationException - if setting of the current working directory is not supported

IllegalArgumentException - if the currentWorkingDirectory is not a valid current working directory

SecurityException - if currentWorkingDirectory is not readable

Since:

1.0

getSeparator

default String getSeparator()

Returns the name separator used to separate names in a path string. The separator is used when creating path strings by invoking the toString() method.

Returns:

the name separator

Since:

1.0