net.java.truevfs.kernel.spec

Enum FsSyncOption

java.lang.Object

java.lang.Enum<FsSyncOption>

net.java.truevfs.kernel.spec.FsSyncOption

All Implemented Interfaces:

Serializable, Comparable<FsSyncOption>

@Immutable
public enum FsSyncOption
extends Enum<FsSyncOption>

Defines options for (virtual) file system synchronization.

Author:

Christian Schlichtherle

See Also:

FsController.sync(BitField), FsSyncOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT_CHANGES If this option is set, all pending changes are aborted.
CLEAR_CACHE Suppose a file system controller has selectively cached entry contents.
FORCE_CLOSE_IO Suppose there are any open I/O streams or channels for any file system entries.
WAIT_CLOSE_IO Suppose there are any open I/O streams or channels for any file system entries.

Method Summary

Modifier and Type	Method and Description
static FsSyncOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static FsSyncOption[]	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

ABORT_CHANGES

public static final FsSyncOption ABORT_CHANGES

If this option is set, all pending changes are aborted. This option is only meaningful immediately before the file system itself gets deleted and should not of used by client applications.

CLEAR_CACHE

public static final FsSyncOption CLEAR_CACHE

Suppose a file system controller has selectively cached entry contents. Then if this option is set when the file system gets synchronized, the entry contents get cleared.

Note that this option may induce dead locks or even busy loops when accessing nested archive files in different threads.

See Also:

#TRUEZIP-268, #TRUEZIP-269

FORCE_CLOSE_IO

public static final FsSyncOption FORCE_CLOSE_IO

Suppose there are any open I/O streams or channels for any file system entries. Then if this option is set, the respective file system controller proceeds to update the file system anyway and finally throws an FsSyncWarningException with a FsOpenResourceException as its cause to indicate that any subsequent operations on these resources will fail with an ClosedInputException or ClosedOutputException respectively because they have been forced to close.

If this option is not set however, the file system is not updated, but instead an FsSyncException with a FsOpenResourceException as its cause is thrown to indicate that the application must close all I/O resources first.

WAIT_CLOSE_IO

public static final FsSyncOption WAIT_CLOSE_IO

Suppose there are any open I/O streams or channels for any file system entries. Then if this option is set, the respective file system controller waits until all other threads have closed their I/O resources before proceeding with the update of the file system. I/O resources allocated by the current thread are always ignored. If the current thread gets interrupted while waiting, it will stop waiting and proceed normally as if this option wasn't set.

WARNING: If an I/O resource has not been closed because the client application does not always properly close its streams, even on an IOException (which is a common bug in many Java applications), then the respective file system controller will not return from the update until the current thread gets interrupted!

Method Detail

valueOf

public static FsSyncOption 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

values

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

Returns:

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