Package org.cryptomator.cryptofs

Enum CryptoFileSystemProperties.FileSystemFlags

java.lang.Object

java.lang.Enum<CryptoFileSystemProperties.FileSystemFlags>

org.cryptomator.cryptofs.CryptoFileSystemProperties.FileSystemFlags

All Implemented Interfaces:

Serializable, Comparable<CryptoFileSystemProperties.FileSystemFlags>

Enclosing class:

CryptoFileSystemProperties

public static enum CryptoFileSystemProperties.FileSystemFlags
extends Enum<CryptoFileSystemProperties.FileSystemFlags>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INIT_IMPLICITLY	Deprecated. Will get removed in version 2.0.0.
MIGRATE_IMPLICITLY	If present, the vault gets automatically migrated during file system creation, which might become significantly slower.
READONLY	If present, the vault is opened in read-only mode.

Method Summary

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

READONLY

public static final CryptoFileSystemProperties.FileSystemFlags READONLY

If present, the vault is opened in read-only mode.

This flag can not be set together with INIT_IMPLICITLY or MIGRATE_IMPLICITLY.

MIGRATE_IMPLICITLY

public static final CryptoFileSystemProperties.FileSystemFlags MIGRATE_IMPLICITLY

If present, the vault gets automatically migrated during file system creation, which might become significantly slower. If absent, a FileSystemNeedsMigrationException will get thrown during the attempt to open a vault that needs migration.

This flag can not be set together with READONLY.

Since:

1.4.0

INIT_IMPLICITLY

@Deprecated
public static final CryptoFileSystemProperties.FileSystemFlags INIT_IMPLICITLY

Deprecated.

Will get removed in version 2.0.0. Use CryptoFileSystemProvider.initialize(Path, String, CharSequence) explicitly.

If present, the vault structure will implicitly get initialized upon filesystem creation.

This flag can not be set together with READONLY.

Method Detail

values

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

Returns:

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

valueOf

public static CryptoFileSystemProperties.FileSystemFlags 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