StandardOpenOption
class StandardOpenOption : OpenOption
| kotlin.Any | ||
| ↳ | kotlin.Enum<java.nio.file.StandardOpenOption> | |
| ↳ | java.nio.file.StandardOpenOption | |
Defines the standard open options.
Summary
| Enum values | |
|---|---|
|
If the file is opened for |
|
|
Create a new file if it does not exist. |
|
|
Create a new file, failing if the file already exists. |
|
|
Delete on close. |
|
|
Requires that every update to the file's content be written synchronously to the underlying storage device. |
|
|
Open for read access. |
|
|
Sparse file. |
|
|
Requires that every update to the file's content or metadata be written synchronously to the underlying storage device. |
|
|
If the file already exists and it is opened for |
|
|
Open for write access. |
|
Enum values
APPEND
enum val APPEND : StandardOpenOption
If the file is opened for WRITE access then bytes will be written to the end of the file rather than the beginning.
If the file is opened for write access by other programs, then it is file system specific if writing to the end of the file is atomic.
CREATE
enum val CREATE : StandardOpenOption
Create a new file if it does not exist. This option is ignored if the CREATE_NEW option is also set. The check for the existence of the file and the creation of the file if it does not exist is atomic with respect to other file system operations.
CREATE_NEW
enum val CREATE_NEW : StandardOpenOption
Create a new file, failing if the file already exists. The check for the existence of the file and the creation of the file if it does not exist is atomic with respect to other file system operations.
DELETE_ON_CLOSE
enum val DELETE_ON_CLOSE : StandardOpenOption
Delete on close. When this option is present then the implementation makes a best effort attempt to delete the file when closed by the appropriate close method. If the close method is not invoked then a best effort attempt is made to delete the file when the Java virtual machine terminates (either normally, as defined by the Java Language Specification, or where possible, abnormally). This option is primarily intended for use with work files that are used solely by a single instance of the Java virtual machine. This option is not recommended for use when opening files that are open concurrently by other entities. Many of the details as to when and how the file is deleted are implementation specific and therefore not specified. In particular, an implementation may be unable to guarantee that it deletes the expected file when replaced by an attacker while the file is open. Consequently, security sensitive applications should take care when using this option.
For security reasons, this option may imply the java.nio.file.LinkOption#NOFOLLOW_LINKS option. In other words, if the option is present when opening an existing file that is a symbolic link then it may fail (by throwing java.io.IOException).
DSYNC
enum val DSYNC : StandardOpenOption
Requires that every update to the file's content be written synchronously to the underlying storage device.
See Also
SPARSE
enum val SPARSE : StandardOpenOption
Sparse file. When used with the CREATE_NEW option then this option provides a hint that the new file will be sparse. The option is ignored when the file system does not support the creation of sparse files.
SYNC
enum val SYNC : StandardOpenOption
Requires that every update to the file's content or metadata be written synchronously to the underlying storage device.
See Also
TRUNCATE_EXISTING
enum val TRUNCATE_EXISTING : StandardOpenOption
If the file already exists and it is opened for WRITE access, then its length is truncated to 0. This option is ignored if the file is opened only for READ access.