DosFileAttributeView
interface DosFileAttributeView : BasicFileAttributeView
java.nio.file.attribute.DosFileAttributeView |
A file attribute view that provides a view of the legacy "DOS" file attributes. These attributes are supported by file systems such as the File Allocation Table (FAT) format commonly used in consumer devices.
A DosFileAttributeView
is a BasicFileAttributeView
that additionally supports access to the set of DOS attribute flags that are used to indicate if the file is read-only, hidden, a system file, or archived.
Where dynamic access to file attributes is required, the attributes supported by this attribute view are as defined by BasicFileAttributeView
, and in addition, the following attributes are supported:
Name | Type |
---|---|
readonly | Boolean |
hidden | Boolean |
system | Boolean |
archive | Boolean |
The getAttribute
method may be used to read any of these attributes, or any of the attributes defined by BasicFileAttributeView
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 defined by BasicFileAttributeView
. It may also be used to update the DOS attributes as if by invoking the setReadOnly
, setHidden
, setSystem
, and setArchive
methods respectively.
Summary
Public methods | |
---|---|
abstract String! |
name() Returns the name of the attribute view. |
abstract DosFileAttributes! | |
abstract Unit |
setArchive(value: Boolean) Updates the value of the archive attribute. |
abstract Unit |
Updates the value of the hidden attribute. |
abstract Unit |
setReadOnly(value: Boolean) Updates the value of the read-only attribute. |
abstract Unit |
Updates the value of the system attribute. |
Inherited functions | |
---|---|
Public methods
name
abstract fun name(): String!
Returns the name of the attribute view. Attribute views of this type have the name "dos"
.
Return | |
---|---|
String! |
the name of the attribute view |
readAttributes
abstract fun readAttributes(): DosFileAttributes!
Return | |
---|---|
DosFileAttributes! |
the file attributes |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs |
java.lang.SecurityException |
In the case of the default provider, a security manager is installed, its checkRead method is invoked to check read access to the file |
setArchive
abstract fun setArchive(value: Boolean): Unit
Updates the value of the archive attribute.
It is implementation specific if the attribute can be updated as an atomic operation with respect to other file system operations. An implementation may, for example, require to read the existing value of the DOS attribute in order to update this attribute.
Parameters | |
---|---|
value |
Boolean: the new value of the attribute |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs |
java.lang.SecurityException |
In the case of the default, and a security manager is installed, its checkWrite method is invoked to check write access to the file |
setHidden
abstract fun setHidden(value: Boolean): Unit
Updates the value of the hidden attribute.
It is implementation specific if the attribute can be updated as an atomic operation with respect to other file system operations. An implementation may, for example, require to read the existing value of the DOS attribute in order to update this attribute.
Parameters | |
---|---|
value |
Boolean: the new value of the attribute |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs |
java.lang.SecurityException |
In the case of the default, and a security manager is installed, its checkWrite method is invoked to check write access to the file |
setReadOnly
abstract fun setReadOnly(value: Boolean): Unit
Updates the value of the read-only attribute.
It is implementation specific if the attribute can be updated as an atomic operation with respect to other file system operations. An implementation may, for example, require to read the existing value of the DOS attribute in order to update this attribute.
Parameters | |
---|---|
value |
Boolean: the new value of the attribute |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs |
java.lang.SecurityException |
In the case of the default, and a security manager is installed, its checkWrite method is invoked to check write access to the file |
setSystem
abstract fun setSystem(value: Boolean): Unit
Updates the value of the system attribute.
It is implementation specific if the attribute can be updated as an atomic operation with respect to other file system operations. An implementation may, for example, require to read the existing value of the DOS attribute in order to update this attribute.
Parameters | |
---|---|
value |
Boolean: the new value of the attribute |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs |
java.lang.SecurityException |
In the case of the default, and a security manager is installed, its checkWrite method is invoked to check write access to the file |