Added in API level 26

Summary: Enums | Methods | Inherited Methods

StandardOpenOption

public final enum StandardOpenOption
extends Enum<StandardOpenOption> implements OpenOption

java.lang.Object
↳	java.lang.Enum<java.nio.file.StandardOpenOption>
	↳	java.nio.file.StandardOpenOption

Defines the standard open options.

Summary

Enum values
`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.
`StandardOpenOption`	`CREATE` Create a new file if it does not exist.
`StandardOpenOption`	`CREATE_NEW` Create a new file, failing if the file already exists.
`StandardOpenOption`	`DELETE_ON_CLOSE` Delete on close.
`StandardOpenOption`	`DSYNC` Requires that every update to the file's content be written synchronously to the underlying storage device.
`StandardOpenOption`	`READ` Open for read access.
`StandardOpenOption`	`SPARSE` Sparse file.
`StandardOpenOption`	`SYNC` Requires that every update to the file's content or metadata be written synchronously to the underlying storage device.
`StandardOpenOption`	`TRUNCATE_EXISTING` If the file already exists and it is opened for `WRITE` access, then its length is truncated to 0.
`StandardOpenOption`	`WRITE` Open for write access.

Public methods
`static StandardOpenOption`	`valueOf(String name)`
`static final StandardOpenOption[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(StandardOpenOption o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`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.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the 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.
`String`	`toString()` Returns a string representation of the object.
`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.
`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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(StandardOpenOption o)

Compares this object with the specified object for order.

Enum values

APPEND

Added in API level 26

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.

CREATE

Added in API level 26

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

Added in API level 26

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

Added in API level 26

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).

DSYNC

Added in API level 26

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

READ

Added in API level 26

public static final StandardOpenOption READ

Open for read access.

SPARSE

Added in API level 26

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

Added in API level 26

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

TRUNCATE_EXISTING

Added in API level 26

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.

WRITE

Added in API level 26

public static final StandardOpenOption WRITE

Open for write access.

Public methods

valueOf

public static StandardOpenOption valueOf (String name)

Parameters
`name`	`String`

Returns
`StandardOpenOption`

values

public static final StandardOpenOption[] values ()

Returns
`StandardOpenOption[]`