Enum Class StandardOpenOption
- All Implemented Interfaces:
public enum StandardOpenOption extends Enum<StandardOpenOption> implements OpenOption
Defines the standard open options.
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Enum Constant SummaryEnum ConstantDescriptionIf the file is opened for
WRITEaccess then bytes will be written to the end of the file rather than the beginning.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
WRITEaccess, then its length is truncated to 0.Open for write access.
Method SummaryModifier and TypeMethodDescription
static StandardOpenOptionReturns the enum constant of this class with the specified name.
values()Returns an array containing the constants of this enum class, in the order they are declared.
Methods declared in class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Enum Constant Details
READpublic static final StandardOpenOption READOpen for read access.
WRITEpublic static final StandardOpenOption WRITEOpen for write access.
APPENDpublic static final StandardOpenOption APPENDIf the file is opened for
WRITEaccess 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_EXISTINGpublic static final StandardOpenOption TRUNCATE_EXISTING
CREATEpublic static final StandardOpenOption CREATECreate a new file if it does not exist. This option is ignored if the
CREATE_NEWoption 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_NEWpublic static final StandardOpenOption CREATE_NEWCreate 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_CLOSEpublic static final StandardOpenOption DELETE_ON_CLOSEDelete on close. When this option is present then the implementation makes a best effort attempt to delete the file when closed by the appropriate
closemethod. If the
closemethod 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_LINKSoption. In other words, if the option is present when opening an existing file that is a symbolic link then it may fail (by throwing
SPARSEpublic static final StandardOpenOption SPARSESparse file. When used with the
CREATE_NEWoption 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.
SYNCpublic static final StandardOpenOption SYNCRequires that every update to the file's content or metadata be written synchronously to the underlying storage device.
- See Also:
DSYNCpublic static final StandardOpenOption DSYNCRequires that every update to the file's content be written synchronously to the underlying storage device.
- See Also:
valuespublic static StandardOpenOption values()Returns an array containing the constants of this enum class, in the order they are declared.
- an array containing the constants of this enum class, in the order they are declared
valueOfpublic 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.)
name- the name of the enum constant to be returned.
- the enum constant with the specified name
IllegalArgumentException- if this enum class has no constant with the specified name
NullPointerException- if the argument is null