-
- All Superinterfaces:
- AttributeView, FileAttributeView
- All Known Subinterfaces:
- DosFileAttributeView, PosixFileAttributeView
public interface BasicFileAttributeView extends FileAttributeView
A file attribute view that provides a view of a basic set of file attributes common to many file systems. The basic set of file attributes consist of mandatory and optional file attributes as defined by theBasicFileAttributes
interface.The file attributes are retrieved from the file system as a bulk operation by invoking the
readAttributes
method. This class also defines thesetTimes
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 thereadAttributes()
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 thesetTimes
method.- Since:
- 1.7
-
-
Method Summary
Methods Modifier and Type Method and Description String
name()
Returns the name of the attribute view.BasicFileAttributes
readAttributes()
Reads the basic file attributes as a bulk operation.void
setTimes(FileTime lastModifiedTime, FileTime lastAccessTime, FileTime createTime)
Updates any or all of the file's last modified time, last access time, and create time attributes.
-
-
-
Method Detail
-
name
String name()
Returns the name of the attribute view. Attribute views of this type have the name"basic"
.- Specified by:
name
in interfaceAttributeView
-
readAttributes
BasicFileAttributes readAttributes() throws IOException
Reads the basic file attributes as a bulk operation.It is implementation specific if all file attributes are read as an atomic operation with respect to other file system operations.
- Returns:
- the file attributes
- Throws:
IOException
- if an I/O error occursSecurityException
- In the case of the default provider, a security manager is installed, itscheckRead
method is invoked to check read access to the file
-
setTimes
void setTimes(FileTime lastModifiedTime, FileTime lastAccessTime, FileTime createTime) throws IOException
Updates any or all of the file's last modified time, last access time, and create time attributes.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 result 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
, orcreateTime
parameters has the valuenull
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 thelastModifiedTime
,lastAccessTime
andcreateTime
parameters arenull
then this method has no effect.Usage Example: Suppose we want to change a file's creation time.
Path path = ... FileTime time = ... Files.getFileAttributeView(path, BasicFileAttributeView.class).setTimes(null, null, time);
- Parameters:
lastModifiedTime
- the new last modified time, ornull
to not change the valuelastAccessTime
- the last access time, ornull
to not change the valuecreateTime
- the file's create time, ornull
to not change the value- Throws:
IOException
- if an I/O error occursSecurityException
- In the case of the default provider, a security manager is installed, itscheckWrite
method is invoked to check write access to the file- See Also:
Files.setLastModifiedTime(java.nio.file.Path, java.nio.file.attribute.FileTime)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/file/attribute/basicfileattributeview.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.