agi.foundation.compatibility

(agi.foundation.core-2024r3.jar)

Enum FileMode

java.lang.Object

java.lang.Enum<FileMode>

agi.foundation.compatibility.FileMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<FileMode>

public enum FileMode
extends Enum<FileMode>
implements Enumeration

Specifies how the operating system should open a file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Opens the file if it exists and seeks to the end of the file, or creates a new file.
CREATE Specifies that the operating system should create a new file.
CREATE_NEW Specifies that the operating system should create a new file.
OPEN Specifies that the operating system should open an existing file.
OPEN_OR_CREATE Specifies that the operating system should open a file if it exists; otherwise, a new file should be created.
TRUNCATE Specifies that the operating system should open an existing file.

Method Summary

Modifier and Type	Method and Description
static FileMode	getDefault() Get the enum constant that is considered to be the default.
static FileMode	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static FileMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPEND

public static final FileMode APPEND

Opens the file if it exists and seeks to the end of the file, or creates a new file. FileMode.Append can only be used in conjunction with FileAccess.Write.

CREATE

public static final FileMode CREATE

Specifies that the operating system should create a new file. If the file already exists, it will be overwritten.

CREATE_NEW

public static final FileMode CREATE_NEW

Specifies that the operating system should create a new file.

OPEN

public static final FileMode OPEN

Specifies that the operating system should open an existing file. The ability to open the file is dependent on the the value specified by FileAccess. A FileNotFoundException is thrown if the file does not exist.

OPEN_OR_CREATE

public static final FileMode OPEN_OR_CREATE

Specifies that the operating system should open a file if it exists; otherwise, a new file should be created.

TRUNCATE

public static final FileMode TRUNCATE

Specifies that the operating system should open an existing file. Once opened, the file should be truncated so that its size is zero bytes.

Method Detail

values

public static FileMode[] 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 (FileMode c : FileMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileMode valueOf(String 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 - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static FileMode getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

public static FileMode getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.