OpenJDK 27 · java.nio.file.SecureDirectoryStream · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	deleteDirectory(T the path of the directory to delete path) Deletes a directory.
public void	deleteFile(T the path of the file to delete path) Deletes a file.
public < The `FileAttributeView` type V extends FileAttributeView> V	Returns: a new file attribute view of the specified type bound to this directory stream, or `null` if the attribute view type is not available getFileAttributeView(Class<V> the `Class` object corresponding to the file attribute view type) Returns a new file attribute view to access the file attributes of this directory.
public < The `FileAttributeView` type V extends FileAttributeView> V	Returns: a new file attribute view of the specified type bound to this directory stream, or `null` if the attribute view type is not available getFileAttributeView(T the path of the file path, Class<V> the `Class` object corresponding to the file attribute view type, LinkOption... options indicating how symbolic links are handled options) Returns a new file attribute view to access the file attributes of a file in this directory.
public void	move(T the name of the file to move srcpath, SecureDirectoryStream<T> the destination directory; can be `null` targetdir, T the name to give the file in the destination directory targetpath) Move a file from this directory to another directory.
public SeekableByteChannel	Returns: the seekable byte channel newByteChannel(T the path of the file to open or create path, Set<? extends OpenOption> options specifying how the file is opened options, FileAttribute<?>... an optional list of attributes to set atomically when creating the file attrs) Opens or creates a file in this directory, returning a seekable byte channel to access the file.
public SecureDirectoryStream<T>	Returns: a new and open `SecureDirectoryStream` object newDirectoryStream(T the path to the directory to open path, LinkOption... options indicating how symbolic links are handled options) Opens the directory identified by the given path, returning a `SecureDirectoryStream` to iterate over the entries in the directory.

Inherited from java.nio.file.DirectoryStream:: iterator

Method Detail

deleteDirectory back to summary

deleteDirectory	back to summary
public void deleteDirectory(T path) throws IOException Deletes a directory. Unlike the `delete()` method, this method does not first examine the file to determine if the file is a directory. Whether non-directories are deleted by this method is system dependent and therefore not specified. When the parameter is a relative path then the directory to delete is relative to this open directory. Parameters path:T the path of the directory to delete Exceptions IOException: if an I/O error occurs ClosedDirectoryStreamException: if the directory stream is closed NoSuchFileException: if the directory does not exist (optional specific exception) DirectoryNotEmptyException: if the directory could not otherwise be deleted because it is not empty (optional specific exception)

public void deleteDirectory(T path) throws IOException

Deletes a directory.

Unlike the delete() method, this method does not first examine the file to determine if the file is a directory. Whether non-directories are deleted by this method is system dependent and therefore not specified. When the parameter is a relative path then the directory to delete is relative to this open directory.

Parameters

path:T: the path of the directory to delete

Exceptions

IOException:: if an I/O error occurs
ClosedDirectoryStreamException:: if the directory stream is closed
NoSuchFileException:: if the directory does not exist (optional specific exception)
DirectoryNotEmptyException:: if the directory could not otherwise be deleted because it is not empty (optional specific exception)

deleteFile back to summary

deleteFile	back to summary
public void deleteFile(T path) throws IOException Deletes a file. Unlike the `delete()` method, this method does not first examine the file to determine if the file is a directory. Whether a directory is deleted by this method is system dependent and therefore not specified. If the file is a symbolic link, then the link itself, not the final target of the link, is deleted. When the parameter is a relative path then the file to delete is relative to this open directory. Parameters path:T the path of the file to delete Exceptions IOException: if an I/O error occurs ClosedDirectoryStreamException: if the directory stream is closed NoSuchFileException: if the file does not exist (optional specific exception)

public void deleteFile(T path) throws IOException

Deletes a file.

Unlike the delete() method, this method does not first examine the file to determine if the file is a directory. Whether a directory is deleted by this method is system dependent and therefore not specified. If the file is a symbolic link, then the link itself, not the final target of the link, is deleted. When the parameter is a relative path then the file to delete is relative to this open directory.

Parameters

path:T: the path of the file to delete

Exceptions

IOException:: if an I/O error occurs
ClosedDirectoryStreamException:: if the directory stream is closed
NoSuchFileException:: if the file does not exist (optional specific exception)

getFileAttributeView back to summary

getFileAttributeView	back to summary
public <V extends FileAttributeView> V getFileAttributeView(Class<V> type) Returns a new file attribute view to access the file attributes of this directory. The resulting file attribute view can be used to read or update the attributes of this (open) directory. The `type` parameter specifies the type of the attribute view and the method returns an instance of that type if supported. Invoking this method to obtain a `BasicFileAttributeView` always returns an instance of that class that is bound to this open directory. The state of resulting file attribute view is intimately connected to this directory stream. Once the directory stream is `closed`, then all methods to read or update attributes will throw `ClosedDirectoryStreamException`. Parameters <V> The `FileAttributeView` type type:Class<V> the `Class` object corresponding to the file attribute view Returns:V a new file attribute view of the specified type bound to this directory stream, or `null` if the attribute view type is not available

public <V extends FileAttributeView> V getFileAttributeView(Class<V> type)

Returns a new file attribute view to access the file attributes of this directory.

The resulting file attribute view can be used to read or update the attributes of this (open) directory. The type parameter specifies the type of the attribute view and the method returns an instance of that type if supported. Invoking this method to obtain a BasicFileAttributeView always returns an instance of that class that is bound to this open directory.

The state of resulting file attribute view is intimately connected to this directory stream. Once the directory stream is closed, then all methods to read or update attributes will throw ClosedDirectoryStreamException.

Parameters

<V>: The FileAttributeView type
type:Class<V>: the Class object corresponding to the file attribute view

Returns:V

a new file attribute view of the specified type bound to this directory stream, or null if the attribute view type is not available

getFileAttributeView back to summary

getFileAttributeView	back to summary
public <V extends FileAttributeView> V getFileAttributeView(T path, Class<V> type, LinkOption... options) Returns a new file attribute view to access the file attributes of a file in this directory. The resulting file attribute view can be used to read or update the attributes of file in this directory. The `type` parameter specifies the type of the attribute view and the method returns an instance of that type if supported. Invoking this method to obtain a `BasicFileAttributeView` always returns an instance of that class that is bound to the file in the directory. The state of resulting file attribute view is intimately connected to this directory stream. Once the directory stream `closed`, then all methods to read or update attributes will throw `ClosedDirectoryStreamException`. The file is not required to exist at the time that the file attribute view is created but methods to read or update attributes of the file will fail when invoked and the file does not exist. Parameters <V> The `FileAttributeView` type path:T the path of the file type:Class<V> the `Class` object corresponding to the file attribute view options:LinkOption[] options indicating how symbolic links are handled Returns:V a new file attribute view of the specified type bound to this directory stream, or `null` if the attribute view type is not available

public <V extends FileAttributeView> V getFileAttributeView(T path, Class<V> type, LinkOption... options)

Returns a new file attribute view to access the file attributes of a file in this directory.

The resulting file attribute view can be used to read or update the attributes of file in this directory. The type parameter specifies the type of the attribute view and the method returns an instance of that type if supported. Invoking this method to obtain a BasicFileAttributeView always returns an instance of that class that is bound to the file in the directory.

The state of resulting file attribute view is intimately connected to this directory stream. Once the directory stream closed, then all methods to read or update attributes will throw ClosedDirectoryStreamException. The file is not required to exist at the time that the file attribute view is created but methods to read or update attributes of the file will fail when invoked and the file does not exist.

Parameters

<V>: The FileAttributeView type
path:T: the path of the file
type:Class<V>: the Class object corresponding to the file attribute view
options:LinkOption[]: options indicating how symbolic links are handled

Returns:V

a new file attribute view of the specified type bound to this directory stream, or null if the attribute view type is not available

move back to summary

move	back to summary
public void move(T srcpath, SecureDirectoryStream<T> targetdir, T targetpath) throws IOException Move a file from this directory to another directory. This method works in a similar manner to `Files.move` when the `ATOMIC_MOVE` option is specified. That is, this method moves a file as an atomic file system operation. If the `srcpath` parameter is an `absolute` path then it locates the source file. If the parameter is a relative path then it is located relative to this open directory. If the `targetpath` parameter is absolute then it locates the target file (the `targetdir` parameter is ignored). If the parameter is a relative path it is located relative to the open directory identified by the `targetdir` parameter, unless `targetdir` is `null`, in which case it is located relative to the current working directory. In all cases, if the target file exists then it is implementation specific if it is replaced or this method fails. Parameters srcpath:T the name of the file to move targetdir:SecureDirectoryStream<T> the destination directory; can be `null` targetpath:T the name to give the file in the destination directory Exceptions IOException: if an I/O error occurs ClosedDirectoryStreamException: if this or the target directory stream is closed FileAlreadyExistsException: if the file already exists in the target directory and cannot be replaced (optional specific exception) AtomicMoveNotSupportedException: if the file cannot be moved as an atomic file system operation

public void move(T srcpath, SecureDirectoryStream<T> targetdir, T targetpath) throws IOException

Move a file from this directory to another directory.

This method works in a similar manner to Files.move when the ATOMIC_MOVE option is specified. That is, this method moves a file as an atomic file system operation. If the srcpath parameter is an absolute path then it locates the source file. If the parameter is a relative path then it is located relative to this open directory. If the targetpath parameter is absolute then it locates the target file (the targetdir parameter is ignored). If the parameter is a relative path it is located relative to the open directory identified by the targetdir parameter, unless targetdir is null, in which case it is located relative to the current working directory. In all cases, if the target file exists then it is implementation specific if it is replaced or this method fails.

Parameters

srcpath:T: the name of the file to move
targetdir:SecureDirectoryStream<T>: the destination directory; can be null
targetpath:T: the name to give the file in the destination directory

Exceptions

IOException:: if an I/O error occurs
ClosedDirectoryStreamException:: if this or the target directory stream is closed
FileAlreadyExistsException:: if the file already exists in the target directory and cannot be replaced (optional specific exception)
AtomicMoveNotSupportedException:: if the file cannot be moved as an atomic file system operation

newByteChannel back to summary

newByteChannel	back to summary
public SeekableByteChannel newByteChannel(T path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) throws IOException Opens or creates a file in this directory, returning a seekable byte channel to access the file. This method works in exactly the manner specified by the `Files.newByteChannel` method for the case that the `path` parameter is an `absolute` path. When the parameter is a relative path then the file to open or create is relative to this open directory. In addition to the options defined by the `Files.newByteChannel` method, the `NOFOLLOW_LINKS` option may be used to ensure that this method fails if the file is a symbolic link. The channel, once created, is not dependent upon the directory stream used to create it. Closing this directory stream has no effect upon the channel. Parameters path:T the path of the file to open or create options:Set<? extends OpenOption> options specifying how the file is opened attrs:FileAttribute<?>[] an optional list of attributes to set atomically when creating the file Returns:SeekableByteChannel the seekable byte channel Exceptions IOException: if an I/O error occurs ClosedDirectoryStreamException: if the directory stream is closed IllegalArgumentException: if the set contains an invalid combination of options UnsupportedOperationException: if an unsupported open option is specified or the array contains attributes that cannot be set atomically when creating the file FileAlreadyExistsException: if a file of that name already exists and the `CREATE_NEW` option is specified (optional specific exception)

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

Opens or creates a file in this directory, returning a seekable byte channel to access the file.

This method works in exactly the manner specified by the Files.newByteChannel method for the case that the path parameter is an absolute path. When the parameter is a relative path then the file to open or create is relative to this open directory. In addition to the options defined by the Files.newByteChannel method, the NOFOLLOW_LINKS option may be used to ensure that this method fails if the file is a symbolic link.

The channel, once created, is not dependent upon the directory stream used to create it. Closing this directory stream has no effect upon the channel.

Parameters

path:T: the path of the file to open or create
options:Set<? extends OpenOption>: options specifying how the file is opened
attrs:FileAttribute<?>[]: an optional list of attributes to set atomically when creating the file

Returns:SeekableByteChannel

the seekable byte channel

Exceptions

IOException:: if an I/O error occurs
ClosedDirectoryStreamException:: if the directory stream is closed
IllegalArgumentException:: if the set contains an invalid combination of options
UnsupportedOperationException:: if an unsupported open option is specified or the array contains attributes that cannot be set atomically when creating the file
FileAlreadyExistsException:: if a file of that name already exists and the CREATE_NEW option is specified (optional specific exception)

newDirectoryStream back to summary

newDirectoryStream	back to summary
public SecureDirectoryStream<T> newDirectoryStream(T path, LinkOption... options) throws IOException Opens the directory identified by the given path, returning a `SecureDirectoryStream` to iterate over the entries in the directory. This method works in exactly the manner specified by the `newDirectoryStream` method for the case that the `path` parameter is an `absolute` path. When the parameter is a relative path then the directory to open is relative to this open directory. The `NOFOLLOW_LINKS` option may be used to ensure that this method fails if the file is a symbolic link. The new directory stream, once created, is not dependent upon the directory stream used to create it. Closing this directory stream has no effect upon newly created directory stream. Parameters path:T the path to the directory to open options:LinkOption[] options indicating how symbolic links are handled Returns:SecureDirectoryStream<T> a new and open `SecureDirectoryStream` object Exceptions IOException: if an I/O error occurs ClosedDirectoryStreamException: if the directory stream is closed NotDirectoryException: if the file could not otherwise be opened because it is not a directory (optional specific exception)

public SecureDirectoryStream<T> newDirectoryStream(T path, LinkOption... options) throws IOException

Opens the directory identified by the given path, returning a SecureDirectoryStream to iterate over the entries in the directory.

This method works in exactly the manner specified by the newDirectoryStream method for the case that the path parameter is an absolute path. When the parameter is a relative path then the directory to open is relative to this open directory. The NOFOLLOW_LINKS option may be used to ensure that this method fails if the file is a symbolic link.

The new directory stream, once created, is not dependent upon the directory stream used to create it. Closing this directory stream has no effect upon newly created directory stream.

Parameters

path:T: the path to the directory to open
options:LinkOption[]: options indicating how symbolic links are handled

Returns:SecureDirectoryStream<T>

a new and open SecureDirectoryStream object

Exceptions

IOException:: if an I/O error occurs
ClosedDirectoryStreamException:: if the directory stream is closed
NotDirectoryException:: if the file could not otherwise be opened because it is not a directory (optional specific exception)

public Interface SecureDirectoryStream<T>

Method Summary

Method Detail