AttributeView
, FileAttributeView
DosFileAttributeView
, PosixFileAttributeView
public interface BasicFileAttributeView extends FileAttributeView
BasicFileAttributes
interface. The file attributes are retrieved from the file system as a bulk operation by invoking the readAttributes
method. This class also defines the setTimes
method to update the file's time attributes.
Where dynamic access to file attributes is required, the attributes supported by this attribute view have the following names and types:
Name Type "lastModifiedTime" FileTime
"lastAccessTime" FileTime
"creationTime" FileTime
"size" Long
"isRegularFile" Boolean
"isDirectory" Boolean
"isSymbolicLink" Boolean
"isOther" Boolean
"fileKey" Object
The getAttribute
method may be used to read any of these attributes as if by invoking the readAttributes()
method.
The setAttribute
method may be used to update the file's last modified time, last access time or create time attributes as if by invoking the setTimes
method.
Modifier and Type | Method | Description |
---|---|---|
String |
name() |
Returns the name of the attribute view. |
BasicFileAttributes |
readAttributes() |
Reads the basic file attributes as a bulk operation. |
void |
setTimes |
Updates any or all of the file's last modified time, last access time, and create time attributes. |
String name()
"basic"
.name
in interface AttributeView
BasicFileAttributes readAttributes() throws IOException
It is implementation specific if all file attributes are read as an atomic operation with respect to other file system operations.
IOException
- if an I/O error occursSecurityException
- In the case of the default provider, a security manager is installed, its checkRead
method is invoked to check read access to the filevoid setTimes(FileTime lastModifiedTime, FileTime lastAccessTime, FileTime createTime) throws IOException
This method updates the file's timestamp attributes. The values are converted to the epoch and precision supported by the file system. Converting from finer to coarser granularities results in precision loss. The behavior of this method when attempting to set a timestamp that is not supported or to a value that is outside the range supported by the underlying file store is not defined. It may or not fail by throwing an IOException
.
If any of the lastModifiedTime
, lastAccessTime
, or createTime
parameters has the value null
then the corresponding timestamp is not changed. An implementation may require to read the existing values of the file attributes when only some, but not all, of the timestamp attributes are updated. Consequently, this method may not be an atomic operation with respect to other file system operations. Reading and re-writing existing values may also result in precision loss. If all of the lastModifiedTime
,
lastAccessTime
and createTime
parameters are null
then this method has no effect.
Usage Example: Suppose we want to change a file's last access time.
Path path = ...
FileTime time = ...
Files.getFileAttributeView(path, BasicFileAttributeView.class).setTimes(null, time, null);
lastModifiedTime
- the new last modified time, or null
to not change the valuelastAccessTime
- the last access time, or null
to not change the valuecreateTime
- the file's create time, or null
to not change the valueIOException
- if an I/O error occursSecurityException
- In the case of the default provider, a security manager is installed, its checkWrite
method is invoked to check write access to the file
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/attribute/BasicFileAttributeView.html