FileSystemProvider (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.nio.file.spi.FileSystemProvider

public abstract class FileSystemProvider
extends Object
Service-provider class for file systems. The methods defined by the Files class will typically delegate to an instance of this class.
A file system provider is a concrete implementation of this class that implements the abstract methods defined by this class. A provider is identified by a URI scheme. The default provider is identified by the URI scheme "file". It creates the FileSystem that provides access to the file systems accessible to the Java virtual machine. The FileSystems class defines how file system providers are located and loaded. The default provider is typically a system-default provider but may be overridden if the system property java.nio.file.spi.DefaultFileSystemProvider is set. In that case, the provider has a one argument constructor whose formal parameter type is FileSystemProvider. All other providers have a zero argument constructor that initializes the provider.
A provider is a factory for one or more FileSystem instances. Each file system is identified by a URI where the URI's scheme matches the provider's scheme. The default file system, for example, is identified by the URI "file:///". A memory-based file system, for example, may be identified by a URI such as "memory:///?name=logfs". The newFileSystem method may be used to create a file system, and the getFileSystem method may be used to obtain a reference to an existing file system created by the provider. Where a provider is the factory for a single file system then it is provider dependent if the file system is created when the provider is initialized, or later when the newFileSystem method is invoked. In the case of the default provider, the FileSystem is created when the provider is initialized.
All of the methods in this class are safe for use by multiple concurrent threads.
Since:
1.7

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileSystemProvider()	Initializes a new instance of this class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods

Modifier and Type	Method	Description
abstract void	checkAccess(Path path,AccessMode... modes)	Checks the existence, and optionally the accessibility, of a file.
abstract void	copy(Path source,Path target,CopyOption... options)	Copy a file to a target file.
abstract void	createDirectory(Path dir,FileAttribute<?>... attrs)	Creates a new directory.
void	createLink(Path link,Path existing)	Creates a new link (directory entry) for an existing file.
void	createSymbolicLink(Path link,Path target,FileAttribute<?>... attrs)	Creates a symbolic link to a target.
abstract void	delete(Path path)	Deletes a file.
boolean	deleteIfExists(Path path)	Deletes a file if it exists.
abstract <V extends FileAttributeView>V	getFileAttributeView(Path path,Class type,LinkOption... options)	Returns a file attribute view of a given type.
abstract FileStore	getFileStore(Path path)	Returns the FileStore representing the file store where a file is located.
abstract FileSystem	getFileSystem(URI uri)	Returns an existing FileSystem created by this provider.
abstract Path	getPath(URI uri)	Return a Path object by converting the given URI.
abstract String	getScheme()	Returns the URI scheme that identifies this provider.
static List<FileSystemProvider>	installedProviders()	Returns a list of the installed file system providers.
abstract boolean	isHidden(Path path)	Tells whether or not a file is considered hidden.
abstract boolean	isSameFile(Path path,Path path2)	Tests if two paths locate the same file.
abstract void	move(Path source,Path target,CopyOption... options)	Move or rename a file to a target file.
AsynchronousFileChannel	newAsynchronousFileChannel(Path path,Set options,[ExecutorService](../../../../java/util/concurrent/ExecutorService.html "interface in java.util.concurrent") executor,[FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")... attrs)	Opens or creates a file for reading and/or writing, returning an asynchronous file channel to access the file.
abstract SeekableByteChannel	newByteChannel(Path path,Set options,[FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")... attrs)	Opens or creates a file, returning a seekable byte channel to access the file.
abstract DirectoryStream<Path>	newDirectoryStream(Path dir,DirectoryStream.Filter<? super Path> filter)	Opens a directory, returning a DirectoryStream to iterate over the entries in the directory.
FileChannel	newFileChannel(Path path,Set options,[FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")... attrs)	Opens or creates a file for reading and/or writing, returning a file channel to access the file.
FileSystem	newFileSystem(Path path,Map<String,?> env)	Constructs a new FileSystem to access the contents of a file as a file system.
abstract FileSystem	newFileSystem(URI uri,Map<String,?> env)	Constructs a new FileSystem object identified by a URI.
InputStream	newInputStream(Path path,OpenOption... options)	Opens a file, returning an input stream to read from the file.
OutputStream	newOutputStream(Path path,OpenOption... options)	Opens or creates a file, returning an output stream that may be used to write bytes to the file.
abstract <A extends BasicFileAttributes>A	readAttributes(Path path,Class type,LinkOption... options)	Reads a file's attributes as a bulk operation.
abstract Map<String,Object>	readAttributes(Path path,String attributes,LinkOption... options)	Reads a set of file attributes as a bulk operation.
Path	readSymbolicLink(Path link)	Reads the target of a symbolic link.
abstract void	setAttribute(Path path,String attribute,Object value,LinkOption... options)	Sets the value of a file attribute.

   * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### FileSystemProvider  
 protected FileSystemProvider()  
 Initializes a new instance of this class.  
  During construction a provider may safely access files associated with the default provider but care needs to be taken to avoid circular loading of other installed providers. If circular loading of installed providers is detected then an unspecified error is thrown.  
 Throws:  
 `[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager has been installed and it denies[RuntimePermission](../../../../java/lang/RuntimePermission.html "class in java.lang")("fileSystemProvider")

Method Detail

* #### installedProviders  
public static [List](../../../../java/util/List.html "interface in java.util")<[FileSystemProvider](../../../../java/nio/file/spi/FileSystemProvider.html "class in java.nio.file.spi")> installedProviders()  
Returns a list of the installed file system providers.  
 The first invocation of this method causes the default provider to be initialized (if not already initialized) and loads any other installed providers as described by the [FileSystems](../../../../java/nio/file/FileSystems.html "class in java.nio.file") class.  
Returns:  
An unmodifiable list of the installed file system providers. The list contains at least one element, that is the default file system provider  
Throws:  
`[ServiceConfigurationError](../../../../java/util/ServiceConfigurationError.html "class in java.util")` \- When an error occurs while loading a service provider  
* #### getScheme  
public abstract [String](../../../../java/lang/String.html "class in java.lang") getScheme()  
Returns the URI scheme that identifies this provider.  
Returns:  
The URI scheme  
* #### newFileSystem  
public abstract [FileSystem](../../../../java/nio/file/FileSystem.html "class in java.nio.file") newFileSystem([URI](../../../../java/net/URI.html "class in java.net") uri,  
                                         [Map](../../../../java/util/Map.html "interface in java.util")<[String](../../../../java/lang/String.html "class in java.lang"),?> env)  
                                  throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Constructs a new `FileSystem` object identified by a URI. This method is invoked by the [FileSystems.newFileSystem(URI,Map)](../../../../java/nio/file/FileSystems.html#newFileSystem-java.net.URI-java.util.Map-) method to open a new file system identified by a URI.  
 The `uri` parameter is an absolute, hierarchical URI, with a scheme equal (without regard to case) to the scheme supported by this provider. The exact form of the URI is highly provider dependent. The`env` parameter is a map of provider specific properties to configure the file system.  
 This method throws [FileSystemAlreadyExistsException](../../../../java/nio/file/FileSystemAlreadyExistsException.html "class in java.nio.file") if the file system already exists because it was previously created by an invocation of this method. Once a file system is [closed](../../../../java/nio/file/FileSystem.html#close--) it is provider-dependent if the provider allows a new file system to be created with the same URI as a file system it previously created.  
Parameters:  
`uri` \- URI reference  
`env` \- A map of provider specific properties to configure the file system; may be empty  
Returns:  
A new file system  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the pre-conditions for the `uri` parameter aren't met, or the `env` parameter does not contain properties required by the provider, or a property value is invalid  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- An I/O error occurs creating the file system  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is installed and it denies an unspecified permission required by the file system provider implementation  
`[FileSystemAlreadyExistsException](../../../../java/nio/file/FileSystemAlreadyExistsException.html "class in java.nio.file")` \- If the file system has already been created  
* #### getFileSystem  
public abstract [FileSystem](../../../../java/nio/file/FileSystem.html "class in java.nio.file") getFileSystem([URI](../../../../java/net/URI.html "class in java.net") uri)  
Returns an existing `FileSystem` created by this provider.  
 This method returns a reference to a `FileSystem` that was created by invoking the [newFileSystem(URI,Map)](../../../../java/nio/file/spi/FileSystemProvider.html#newFileSystem-java.net.URI-java.util.Map-) method. File systems created the [newFileSystem(Path,Map)](../../../../java/nio/file/spi/FileSystemProvider.html#newFileSystem-java.nio.file.Path-java.util.Map-) method are not returned by this method. The file system is identified by its `URI`. Its exact form is highly provider dependent. In the case of the default provider the URI's path component is `"/"` and the authority, query and fragment components are undefined (Undefined components are represented by `null`).  
 Once a file system created by this provider is [closed](../../../../java/nio/file/FileSystem.html#close--) it is provider-dependent if this method returns a reference to the closed file system or throws [FileSystemNotFoundException](../../../../java/nio/file/FileSystemNotFoundException.html "class in java.nio.file"). If the provider allows a new file system to be created with the same URI as a file system it previously created then this method throws the exception if invoked after the file system is closed (and before a new instance is created by the [newFileSystem](../../../../java/nio/file/spi/FileSystemProvider.html#newFileSystem-java.net.URI-java.util.Map-) method).  
 If a security manager is installed then a provider implementation may require to check a permission before returning a reference to an existing file system. In the case of the [default](../../../../java/nio/file/FileSystems.html#getDefault--) file system, no permission check is required.  
Parameters:  
`uri` \- URI reference  
Returns:  
The file system  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the pre-conditions for the `uri` parameter aren't met  
`[FileSystemNotFoundException](../../../../java/nio/file/FileSystemNotFoundException.html "class in java.nio.file")` \- If the file system does not exist  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is installed and it denies an unspecified permission.  
* #### getPath  
public abstract [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") getPath([URI](../../../../java/net/URI.html "class in java.net") uri)  
Return a `Path` object by converting the given [URI](../../../../java/net/URI.html "class in java.net"). The resulting `Path` is associated with a [FileSystem](../../../../java/nio/file/FileSystem.html "class in java.nio.file") that already exists or is constructed automatically.  
 The exact form of the URI is file system provider dependent. In the case of the default provider, the URI scheme is `"file"` and the given URI has a non-empty path component, and undefined query, and fragment components. The resulting `Path` is associated with the default [default](../../../../java/nio/file/FileSystems.html#getDefault--) `FileSystem`.  
 If a security manager is installed then a provider implementation may require to check a permission. In the case of the [default](../../../../java/nio/file/FileSystems.html#getDefault--) file system, no permission check is required.  
Parameters:  
`uri` \- The URI to convert  
Returns:  
The resulting `Path`  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the URI scheme does not identify this provider or other preconditions on the uri parameter do not hold  
`[FileSystemNotFoundException](../../../../java/nio/file/FileSystemNotFoundException.html "class in java.nio.file")` \- The file system, identified by the URI, does not exist and cannot be created automatically  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is installed and it denies an unspecified permission.  
* #### newFileSystem  
public [FileSystem](../../../../java/nio/file/FileSystem.html "class in java.nio.file") newFileSystem([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                [Map](../../../../java/util/Map.html "interface in java.util")<[String](../../../../java/lang/String.html "class in java.lang"),?> env)  
                         throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Constructs a new `FileSystem` to access the contents of a file as a file system.  
 This method is intended for specialized providers of pseudo file systems where the contents of one or more files is treated as a file system. The `env` parameter is a map of provider specific properties to configure the file system.  
 If this provider does not support the creation of such file systems or if the provider does not recognize the file type of the given file then it throws `UnsupportedOperationException`. The default implementation of this method throws `UnsupportedOperationException`.  
Parameters:  
`path` \- The path to the file  
`env` \- A map of provider specific properties to configure the file system; may be empty  
Returns:  
A new file system  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- If this provider does not support access to the contents as a file system or it does not recognize the file type of the given file  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the `env` parameter does not contain properties required by the provider, or a property value is invalid  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is installed and it denies an unspecified permission.  
* #### newInputStream  
public [InputStream](../../../../java/io/InputStream.html "class in java.io") newInputStream([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                  [OpenOption](../../../../java/nio/file/OpenOption.html "interface in java.nio.file")... options)  
                           throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file to open  
`options` \- options specifying how the file is opened  
Returns:  
a new input stream  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if an invalid combination of options is specified  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if an unsupported option is specified  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the file.  
* #### newOutputStream  
public [OutputStream](../../../../java/io/OutputStream.html "class in java.io") newOutputStream([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                    [OpenOption](../../../../java/nio/file/OpenOption.html "interface in java.nio.file")... options)  
                             throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file to open or create  
`options` \- options specifying how the file is opened  
Returns:  
a new output stream  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `options` contains an invalid combination of options  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if an unsupported option is specified  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access to the file. The [checkDelete](../../../../java/lang/SecurityManager.html#checkDelete-java.lang.String-) method is invoked to check delete access if the file is opened with the`DELETE_ON_CLOSE` option.  
* #### newFileChannel  
public [FileChannel](../../../../java/nio/channels/FileChannel.html "class in java.nio.channels") newFileChannel([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                  [Set](../../../../java/util/Set.html "interface in java.util")<? extends [OpenOption](../../../../java/nio/file/OpenOption.html "interface in java.nio.file")> options,  
                                  [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<?>... attrs)  
                           throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Opens or creates a file for reading and/or writing, returning a file channel to access the file. This method works in exactly the manner specified by the [FileChannel.open](../../../../java/nio/channels/FileChannel.html#open-java.nio.file.Path-java.util.Set-java.nio.file.attribute.FileAttribute...-) method. A provider that does not support all the features required to construct a file channel throws `UnsupportedOperationException`. The default provider is required to support the creation of file channels. When not overridden, the default implementation throws `UnsupportedOperationException`.  
Parameters:  
`path` \- the path of the file to open or create  
`options` \- options specifying how the file is opened  
`attrs` \- an optional list of file attributes to set atomically when creating the file  
Returns:  
a new file channel  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the set contains an invalid combination of options  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- If this provider that does not support creating file channels, or an unsupported open option or file attribute is specified  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default file system, the [SecurityManager.checkRead(String)](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access if the file is opened for reading. The [SecurityManager.checkWrite(String)](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access if the file is opened for writing  
* #### newAsynchronousFileChannel  
public [AsynchronousFileChannel](../../../../java/nio/channels/AsynchronousFileChannel.html "class in java.nio.channels") newAsynchronousFileChannel([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                                          [Set](../../../../java/util/Set.html "interface in java.util")<? extends [OpenOption](../../../../java/nio/file/OpenOption.html "interface in java.nio.file")> options,  
                                                          [ExecutorService](../../../../java/util/concurrent/ExecutorService.html "interface in java.util.concurrent") executor,  
                                                          [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<?>... attrs)  
                                                   throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Opens or creates a file for reading and/or writing, returning an asynchronous file channel to access the file. This method works in exactly the manner specified by the [AsynchronousFileChannel.open](../../../../java/nio/channels/AsynchronousFileChannel.html#open-java.nio.file.Path-java.util.Set-java.util.concurrent.ExecutorService-java.nio.file.attribute.FileAttribute...-) method. A provider that does not support all the features required to construct an asynchronous file channel throws `UnsupportedOperationException`. The default provider is required to support the creation of asynchronous file channels. When not overridden, the default implementation of this method throws `UnsupportedOperationException`.  
Parameters:  
`path` \- the path of the file to open or create  
`options` \- options specifying how the file is opened  
`executor` \- the thread pool or `null` to associate the channel with the default thread pool  
`attrs` \- an optional list of file attributes to set atomically when creating the file  
Returns:  
a new asynchronous file channel  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If the set contains an invalid combination of options  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- If this provider that does not support creating asynchronous file channels, or an unsupported open option or file attribute is specified  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default file system, the [SecurityManager.checkRead(String)](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access if the file is opened for reading. The [SecurityManager.checkWrite(String)](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access if the file is opened for writing  
* #### newByteChannel  
public abstract [SeekableByteChannel](../../../../java/nio/channels/SeekableByteChannel.html "interface in java.nio.channels") newByteChannel([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                                   [Set](../../../../java/util/Set.html "interface in java.util")<? extends [OpenOption](../../../../java/nio/file/OpenOption.html "interface in java.nio.file")> options,  
                                                   [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<?>... attrs)  
                                            throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Opens or creates a file, returning a seekable byte channel to access the file. This method works in exactly the manner specified by the [Files.newByteChannel(Path,Set,FileAttribute\[\])](../../../../java/nio/file/Files.html#newByteChannel-java.nio.file.Path-java.util.Set-java.nio.file.attribute.FileAttribute...-) method.  
Parameters:  
`path` \- the path to the file to open or create  
`options` \- options specifying how the file is opened  
`attrs` \- an optional list of file attributes to set atomically when creating the file  
Returns:  
a new seekable byte channel  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the set contains an invalid combination of options  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if an unsupported open option is specified or the array contains attributes that cannot be set atomically when creating the file  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if a file of that name already exists and the [CREATE\_NEW](../../../../java/nio/file/StandardOpenOption.html#CREATE%5FNEW) option is specified_(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the path if the file is opened for reading. The [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access to the path if the file is opened for writing. The [checkDelete](../../../../java/lang/SecurityManager.html#checkDelete-java.lang.String-) method is invoked to check delete access if the file is opened with the`DELETE_ON_CLOSE` option.  
* #### newDirectoryStream  
public abstract [DirectoryStream](../../../../java/nio/file/DirectoryStream.html "interface in java.nio.file")<[Path](../../../../java/nio/file/Path.html "interface in java.nio.file")> newDirectoryStream([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") dir,  
                                                         [DirectoryStream.Filter](../../../../java/nio/file/DirectoryStream.Filter.html "interface in java.nio.file")<? super [Path](../../../../java/nio/file/Path.html "interface in java.nio.file")> filter)  
                                                  throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`dir` \- the path to the directory  
`filter` \- the directory stream filter  
Returns:  
a new and open `DirectoryStream` object  
Throws:  
`[NotDirectoryException](../../../../java/nio/file/NotDirectoryException.html "class in java.nio.file")` \- if the file could not otherwise be opened because it is not a directory _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the directory.  
* #### createDirectory  
public abstract void createDirectory([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") dir,  
                                     [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<?>... attrs)  
                              throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`dir` \- the directory to create  
`attrs` \- an optional list of file attributes to set atomically when creating the directory  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the array contains an attribute that cannot be set atomically when creating the directory  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if a directory could not otherwise be created because a file of that name already exists _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs or the parent directory does not exist  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access to the new directory.  
* #### createSymbolicLink  
public void createSymbolicLink([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") link,  
                               [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") target,  
                               [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<?>... attrs)  
                        throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`link` \- the path of the symbolic link to create  
`target` \- the target of the symbolic link  
`attrs` \- the array of attributes to set atomically when creating the symbolic link  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the implementation does not support symbolic links or the array contains an attribute that cannot be set atomically when creating the symbolic link  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if a file with the name already exists _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, it denies [LinkPermission](../../../../java/nio/file/LinkPermission.html "class in java.nio.file")("symbolic") or its [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method denies write access to the path of the symbolic link.  
* #### createLink  
public void createLink([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") link,  
                       [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") existing)  
                throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`link` \- the link (directory entry) to create  
`existing` \- a path to an existing file  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the implementation does not support adding an existing file to a directory  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if the entry could not otherwise be created because a file of that name already exists _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, it denies [LinkPermission](../../../../java/nio/file/LinkPermission.html "class in java.nio.file")("hard") or its [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method denies write access to either the link or the existing file.  
* #### delete  
public abstract void delete([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path)  
                     throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file to delete  
Throws:  
`[NoSuchFileException](../../../../java/nio/file/NoSuchFileException.html "class in java.nio.file")` \- if the file does not exist _(optional specific exception)_  
`[DirectoryNotEmptyException](../../../../java/nio/file/DirectoryNotEmptyException.html "class in java.nio.file")` \- if the file is a directory and could not otherwise be deleted because the directory is not empty _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [SecurityManager.checkDelete(String)](../../../../java/lang/SecurityManager.html#checkDelete-java.lang.String-) method is invoked to check delete access to the file  
* #### deleteIfExists  
public boolean deleteIfExists([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path)  
                       throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file to delete  
Returns:  
`true` if the file was deleted by this method; `false` if the file could not be deleted because it did not exist  
Throws:  
`[DirectoryNotEmptyException](../../../../java/nio/file/DirectoryNotEmptyException.html "class in java.nio.file")` \- if the file is a directory and could not otherwise be deleted because the directory is not empty _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [SecurityManager.checkDelete(String)](../../../../java/lang/SecurityManager.html#checkDelete-java.lang.String-) method is invoked to check delete access to the file  
* #### readSymbolicLink  
public [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") readSymbolicLink([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") link)  
                      throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Reads the target of a symbolic link. This method works in exactly the manner specified by the [Files.readSymbolicLink(java.nio.file.Path)](../../../../java/nio/file/Files.html#readSymbolicLink-java.nio.file.Path-) method.  
 The default implementation of this method throws `UnsupportedOperationException`.  
Parameters:  
`link` \- the path to the symbolic link  
Returns:  
The target of the symbolic link  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the implementation does not support symbolic links  
`[NotLinkException](../../../../java/nio/file/NotLinkException.html "class in java.nio.file")` \- if the target could otherwise not be read because the file is not a symbolic link _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, it checks that `FilePermission` has been granted with the "`readlink`" action to read the link.  
* #### copy  
public abstract void copy([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") source,  
                          [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") target,  
                          [CopyOption](../../../../java/nio/file/CopyOption.html "interface in java.nio.file")... options)  
                   throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Copy a file to a target file. This method works in exactly the manner specified by the [Files.copy(Path,Path,CopyOption\[\])](../../../../java/nio/file/Files.html#copy-java.nio.file.Path-java.nio.file.Path-java.nio.file.CopyOption...-) method except that both the source and target paths must be associated with this provider.  
Parameters:  
`source` \- the path to the file to copy  
`target` \- the path to the target file  
`options` \- options specifying how the copy should be done  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the array contains a copy option that is not supported  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if the target file exists but cannot be replaced because the`REPLACE_EXISTING` option is not specified _(optional specific exception)_  
`[DirectoryNotEmptyException](../../../../java/nio/file/DirectoryNotEmptyException.html "class in java.nio.file")` \- the `REPLACE_EXISTING` option is specified but the file cannot be replaced because it is a non-empty directory_(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the source file, the[checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) is invoked to check write access to the target file. If a symbolic link is copied the security manager is invoked to check [LinkPermission](../../../../java/nio/file/LinkPermission.html "class in java.nio.file")`("symbolic")`.  
* #### move  
public abstract void move([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") source,  
                          [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") target,  
                          [CopyOption](../../../../java/nio/file/CopyOption.html "interface in java.nio.file")... options)  
                   throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`source` \- the path to the file to move  
`target` \- the path to the target file  
`options` \- options specifying how the move should be done  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the array contains a copy option that is not supported  
`[FileAlreadyExistsException](../../../../java/nio/file/FileAlreadyExistsException.html "class in java.nio.file")` \- if the target file exists but cannot be replaced because the`REPLACE_EXISTING` option is not specified _(optional specific exception)_  
`[DirectoryNotEmptyException](../../../../java/nio/file/DirectoryNotEmptyException.html "class in java.nio.file")` \- the `REPLACE_EXISTING` option is specified but the file cannot be replaced because it is a non-empty directory_(optional specific exception)_  
`[AtomicMoveNotSupportedException](../../../../java/nio/file/AtomicMoveNotSupportedException.html "class in java.nio.file")` \- if the options array contains the `ATOMIC_MOVE` option but the file cannot be moved as an atomic file system operation.  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method is invoked to check write access to both the source and target file.  
* #### isSameFile  
public abstract boolean isSameFile([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                   [Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path2)  
                            throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- one path to the file  
`path2` \- the other path  
Returns:  
`true` if, and only if, the two paths locate the same file  
Throws:  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to both files.  
* #### isHidden  
public abstract boolean isHidden([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path)  
                          throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file to test  
Returns:  
`true` if the file is considered hidden  
Throws:  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the file.  
* #### getFileStore  
public abstract [FileStore](../../../../java/nio/file/FileStore.html "class in java.nio.file") getFileStore([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path)  
                                throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file  
Returns:  
the file store where the file is stored  
Throws:  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the file, and in addition it checks [RuntimePermission](../../../../java/lang/RuntimePermission.html "class in java.lang") ("getFileStoreAttributes")  
* #### checkAccess  
public abstract void checkAccess([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                 [AccessMode](../../../../java/nio/file/AccessMode.html "enum in java.nio.file")... modes)  
                          throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Checks the existence, and optionally the accessibility, of a file.  
 This method may be used by the [isReadable](../../../../java/nio/file/Files.html#isReadable-java.nio.file.Path-),[isWritable](../../../../java/nio/file/Files.html#isWritable-java.nio.file.Path-) and [isExecutable](../../../../java/nio/file/Files.html#isExecutable-java.nio.file.Path-) methods to check the accessibility of a file.  
 This method checks the existence of a file and that this Java virtual machine has appropriate privileges that would allow it access the file according to all of access modes specified in the `modes` parameter as follows:  
| Value                                                        | Description                                                                                                                                                                                                                                                                                                                                                                                                   |  
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |  
| [READ](../../../../java/nio/file/AccessMode.html#READ)       | Checks that the file exists and that the Java virtual machine has permission to read the file.                                                                                                                                                                                                                                                                                                                |  
| [WRITE](../../../../java/nio/file/AccessMode.html#WRITE)     | Checks that the file exists and that the Java virtual machine has permission to write to the file,                                                                                                                                                                                                                                                                                                            |  
| [EXECUTE](../../../../java/nio/file/AccessMode.html#EXECUTE) | Checks that the file exists and that the Java virtual machine has permission to [execute](../../../../java/lang/Runtime.html#exec-java.lang.String-) the file. The semantics may differ when checking access to a directory. For example, on UNIX systems, checking for EXECUTE access checks that the Java virtual machine has permission to search the directory in order to access file or subdirectories. |  
 If the `modes` parameter is of length zero, then the existence of the file is checked.  
 This method follows symbolic links if the file referenced by this object is a symbolic link. Depending on the implementation, this method may require to read file permissions, access control lists, or other file attributes in order to check the effective access to the file. To determine the effective access to a file may require access to several attributes and so in some implementations this method may not be atomic with respect to other file system operations.  
Parameters:  
`path` \- the path to the file to check  
`modes` \- The access modes to check; may have zero elements  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- an implementation is required to support checking for`READ`, `WRITE`, and `EXECUTE` access. This exception is specified to allow for the `Access` enum to be extended in future releases.  
`[NoSuchFileException](../../../../java/nio/file/NoSuchFileException.html "class in java.nio.file")` \- if a file does not exist _(optional specific exception)_  
`[AccessDeniedException](../../../../java/nio/file/AccessDeniedException.html "class in java.nio.file")` \- the requested access would be denied or the access cannot be determined because the Java virtual machine has insufficient privileges or other reasons. _(optional specific exception)_  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, the [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) is invoked when checking read access to the file or only the existence of the file, the [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) is invoked when checking write access to the file, and [checkExec](../../../../java/lang/SecurityManager.html#checkExec-java.lang.String-) is invoked when checking execute access.  
* #### getFileAttributeView  
public abstract <V extends [FileAttributeView](../../../../java/nio/file/attribute/FileAttributeView.html "interface in java.nio.file.attribute")> V getFileAttributeView([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                                                     [Class](../../../../java/lang/Class.html "class in java.lang")<V> type,  
                                                                     [LinkOption](../../../../java/nio/file/LinkOption.html "enum in java.nio.file")... options)  
Type Parameters:  
`V` \- The `FileAttributeView` type  
Parameters:  
`path` \- the path to the file  
`type` \- the `Class` object corresponding to the file attribute view  
`options` \- options indicating how symbolic links are handled  
Returns:  
a file attribute view of the specified type, or `null` if the attribute view type is not available  
* #### readAttributes  
public abstract <A extends [BasicFileAttributes](../../../../java/nio/file/attribute/BasicFileAttributes.html "interface in java.nio.file.attribute")> A readAttributes([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                                                 [Class](../../../../java/lang/Class.html "class in java.lang")<A> type,  
                                                                 [LinkOption](../../../../java/nio/file/LinkOption.html "enum in java.nio.file")... options)  
                                                          throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Type Parameters:  
`A` \- The `BasicFileAttributes` type  
Parameters:  
`path` \- the path to the file  
`type` \- the `Class` of the file attributes required to read  
`options` \- options indicating how symbolic links are handled  
Returns:  
the file attributes  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if an attributes of the given type are not supported  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, a security manager is installed, its [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method is invoked to check read access to the file  
* #### readAttributes  
public abstract [Map](../../../../java/util/Map.html "interface in java.util")<[String](../../../../java/lang/String.html "class in java.lang"),[Object](../../../../java/lang/Object.html "class in java.lang")> readAttributes([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                                  [String](../../../../java/lang/String.html "class in java.lang") attributes,  
                                                  [LinkOption](../../../../java/nio/file/LinkOption.html "enum in java.nio.file")... options)  
                                           throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file  
`attributes` \- the attributes to read  
`options` \- options indicating how symbolic links are handled  
Returns:  
a map of the attributes returned; may be empty. The map's keys are the attribute names, its values are the attribute values  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the attribute view is not available  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if no attributes are specified or an unrecognized attributes is specified  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, its [checkRead](../../../../java/lang/SecurityManager.html#checkRead-java.lang.String-) method denies read access to the file. If this method is invoked to read security sensitive attributes then the security manager may be invoke to check for additional permissions.  
* #### setAttribute  
public abstract void setAttribute([Path](../../../../java/nio/file/Path.html "interface in java.nio.file") path,  
                                  [String](../../../../java/lang/String.html "class in java.lang") attribute,  
                                  [Object](../../../../java/lang/Object.html "class in java.lang") value,  
                                  [LinkOption](../../../../java/nio/file/LinkOption.html "enum in java.nio.file")... options)  
                           throws [IOException](../../../../java/io/IOException.html "class in java.io")  
Parameters:  
`path` \- the path to the file  
`attribute` \- the attribute to set  
`value` \- the attribute value  
`options` \- options indicating how symbolic links are handled  
Throws:  
`[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the attribute view is not available  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the attribute name is not specified, or is not recognized, or the attribute value is of the correct type but has an inappropriate value  
`[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")` \- If the attribute value is not of the expected type or is a collection containing elements that are not of the expected type  
`[IOException](../../../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
`[SecurityException](../../../../java/lang/SecurityException.html "class in java.lang")` \- In the case of the default provider, and a security manager is installed, its [checkWrite](../../../../java/lang/SecurityManager.html#checkWrite-java.lang.String-) method denies write access to the file. If this method is invoked to set security sensitive attributes then the security manager may be invoked to check for additional permissions.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

FileSystemProvider (Java Platform SE 8 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail