Serializable
, Comparable<StandardOpenOption>
, Constable
, OpenOption
public enum StandardOpenOption extends Enum<StandardOpenOption> implements OpenOption
Enum.EnumDesc<E extends Enum<E>>
Enum Constant | Description |
---|---|
APPEND |
If the file is opened for WRITE access then bytes will be written to the end of the file rather than the beginning. |
CREATE |
Create a new file if it does not exist. |
CREATE_NEW |
Create a new file, failing if the file already exists. |
DELETE_ON_CLOSE |
Delete on close. |
DSYNC |
Requires that every update to the file's content be written synchronously to the underlying storage device. |
READ |
Open for read access. |
SPARSE |
Sparse file. |
SYNC |
Requires that every update to the file's content or metadata be written synchronously to the underlying storage device. |
TRUNCATE_EXISTING |
If the file already exists and it is opened for WRITE access, then its length is truncated to 0. |
WRITE |
Open for write access. |
Modifier and Type | Method | Description |
---|---|---|
static StandardOpenOption |
valueOf |
Returns the enum constant of this class with the specified name. |
static StandardOpenOption[] |
values() |
Returns an array containing the constants of this enum class, in the order they are declared. |
public static final StandardOpenOption READ
public static final StandardOpenOption WRITE
public static final StandardOpenOption APPEND
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.
public static final StandardOpenOption TRUNCATE_EXISTING
public static final StandardOpenOption CREATE
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.public static final StandardOpenOption CREATE_NEW
public static final StandardOpenOption DELETE_ON_CLOSE
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 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 IOException
).
public static final StandardOpenOption SPARSE
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.public static final StandardOpenOption SYNC
public static final StandardOpenOption DSYNC
public static StandardOpenOption[] values()
public static StandardOpenOption valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
© 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/StandardOpenOption.html