StandardOpenOption (Java Platform SE 8 ) (original) (raw)
- java.lang.Enum<StandardOpenOption>
- java.nio.file.StandardOpenOption
All Implemented Interfaces:
Serializable, Comparable<StandardOpenOption>, OpenOption
public enum StandardOpenOption
extends Enum<StandardOpenOption>
implements OpenOption
Defines the standard open options.
Since:
1.7
Enum Constant Summary
Enum Constants
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. Method Summary
All Methods Static Methods Concrete Methods
Modifier and Type Method Description static StandardOpenOption valueOf(String name) Returns the enum constant of this type with the specified name. static StandardOpenOption[] values() Returns an array containing the constants of this enum type, in the order they are declared. * ### Methods inherited from class java.lang.[Enum](../../../java/lang/Enum.html "class in java.lang") `[clone](../../../java/lang/Enum.html#clone--), [compareTo](../../../java/lang/Enum.html#compareTo-E-), [equals](../../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../../java/lang/Enum.html#hashCode--), [name](../../../java/lang/Enum.html#name--), [ordinal](../../../java/lang/Enum.html#ordinal--), [toString](../../../java/lang/Enum.html#toString--), [valueOf](../../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)` * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang") `[getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`Enum Constant Detail
* #### READ public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") READ Open for read access. * #### WRITE public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") WRITE Open for write access. * #### APPEND public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") APPEND If the file is opened for [WRITE](../../../java/nio/file/StandardOpenOption.html#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. * #### TRUNCATE\_EXISTING public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") TRUNCATE_EXISTING If the file already exists and it is opened for [WRITE](../../../java/nio/file/StandardOpenOption.html#WRITE) access, then its length is truncated to 0\. This option is ignored if the file is opened only for [READ](../../../java/nio/file/StandardOpenOption.html#READ) access. * #### CREATE public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") CREATE Create a new file if it does not exist. This option is ignored if the [CREATE\_NEW](../../../java/nio/file/StandardOpenOption.html#CREATE%5FNEW) 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 public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") CREATE_NEW 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 public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") DELETE_ON_CLOSE 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 [LinkOption.NOFOLLOW\_LINKS](../../../java/nio/file/LinkOption.html#NOFOLLOW%5FLINKS) 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](../../../java/io/IOException.html "class in java.io")). * #### SPARSE public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") SPARSE Sparse file. When used with the [CREATE\_NEW](../../../java/nio/file/StandardOpenOption.html#CREATE%5FNEW) 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 public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") SYNC Requires that every update to the file's content or metadata be written synchronously to the underlying storage device. See Also: [Synchronized I/O file integrity](package-summary.html#integrity) * #### DSYNC public static final [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") DSYNC Requires that every update to the file's content be written synchronously to the underlying storage device. See Also: [Synchronized I/O file integrity](package-summary.html#integrity)Method Detail
* #### values public static [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file")[] values() Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: for (StandardOpenOption c : StandardOpenOption.values()) System.out.println(c); Returns: an array containing the constants of this enum type, in the order they are declared * #### valueOf public static [StandardOpenOption](../../../java/nio/file/StandardOpenOption.html "enum in java.nio.file") valueOf([String](../../../java/lang/String.html "class in java.lang") name) Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Parameters: `name` \- the name of the enum constant to be returned. Returns: the enum constant with the specified name Throws: `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.