1. Description
2. Nested Class Summary
3. Enum Constant Summary
4. Method Summary
5. Enum Constant Details
   1. READ
   2. WRITE
   3. APPEND
   4. TRUNCATE_EXISTING
   5. CREATE
   6. CREATE_NEW
   7. DELETE_ON_CLOSE
   8. SPARSE
   9. SYNC
   10. DSYNC
6. Method Details
   1. values()
   2. valueOf(String)

• Nested Class Summary

  Nested classes/interfaces declared in class Enum

  Enum.EnumDesc<E>

  Modifier and Type

  Class

  Description

  static final class 

  Enum.EnumDesc<E extends Enum<E>>

  A nominal descriptor for an enum constant.

• 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 MethodsStatic MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static StandardOpenOption

  valueOf(String name)

  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.

  Methods declared in class Enum

  clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

  Modifier and Type

  Method

  Description

  protected final Object

  clone()

  Throws CloneNotSupportedException.

  final int

  compareTo(StandardOpenOption o)

  Compares this enum with the specified object for order.

  final Optional<Enum.EnumDesc<StandardOpenOption>>

  describeConstable()

  Returns an enum descriptor EnumDesc for this instance, if one can be constructed, or an empty Optional if one cannot be.

  final boolean

  equals(Object other)

  Returns true if the specified object is equal to this enum constant.

  protected final void

  finalize()

  Deprecated, for removal: This API element is subject to removal in a future version.

  Finalization has been deprecated for removal.

  final Class<StandardOpenOption>

  getDeclaringClass()

  Returns the Class object corresponding to this enum constant's enum type.

  final int

  hashCode()

  Returns a hash code for this enum constant.

  final String

  name()

  Returns the name of this enum constant, exactly as declared in its enum declaration.

  final int

  ordinal()

  Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

  String

  toString()

  Returns the name of this enum constant, as contained in the declaration.

  static <T extends Enum<T>>
  T

  valueOf(Class<T> enumClass, String name)

  Returns the enum constant of the specified enum class with the specified name.

  Methods declared in class Object

  getClass, notify, notifyAll, wait, wait, wait

  Modifier and Type

  Method

  Description

  final Class<?>

  getClass()

  Returns the runtime class of this Object.

  final void

  notify()

  Wakes up a single thread that is waiting on this object's monitor.

  final void

  notifyAll()

  Wakes up all threads that are waiting on this object's monitor.

  final void

  wait()

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

  final void

  wait(long timeoutMillis)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  final void

  wait(long timeoutMillis, int nanos)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

• Enum Constant Details

  • READ

    public static final StandardOpenOption READ

    Open for read access.

  • WRITE

    public static final StandardOpenOption WRITE

    Open for write access.

  • APPEND

    public static final StandardOpenOption APPEND

    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.

  • TRUNCATE_EXISTING

    public static final StandardOpenOption TRUNCATE_EXISTING

    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.

  • CREATE

    public static final StandardOpenOption CREATE

    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

    public static final StandardOpenOption 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 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 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).

  • SPARSE

    public static final StandardOpenOption SPARSE

    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

    public static final StandardOpenOption 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

  • DSYNC

    public static final StandardOpenOption 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

• Method Details

  • values

    public static StandardOpenOption[] values()

    Returns an array containing the constants of this enum class, in the order they are declared.

    Returns: an array containing the constants of this enum class, in the order they are declared

  • valueOf

    public static StandardOpenOption valueOf(String name)

    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 - if this enum class has no constant with the specified name NullPointerException - if the argument is null

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.