Package com.couchbase.client.java.encryption.annotation

Enum Encrypted.Migration

java.lang.Object

java.lang.Enum<Encrypted.Migration>

com.couchbase.client.java.encryption.annotation.Encrypted.Migration

All Implemented Interfaces:

Serializable, Comparable<Encrypted.Migration>, java.lang.constant.Constable

Enclosing class:

Encrypted

@Volatile
public static enum Encrypted.Migration
extends Enum<Encrypted.Migration>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FROM_UNENCRYPTED	During deserialization, accept an unencrypted value if an encrypted value is not present.
NONE	During deserialization, when an unencrypted value is encountered it will either be ignored or cause data binding to fail (depending on other deserialization settings).

Method Summary

Modifier and Type	Method	Description
static Encrypted.Migration	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Encrypted.Migration[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FROM_UNENCRYPTED

public static final Encrypted.Migration FROM_UNENCRYPTED

During deserialization, accept an unencrypted value if an encrypted value is not present. This enables seamless migration when adding encryption to an existing field. The drawback is that it removes any guarantee the field was written by someone in possession of the secret key, since encryption implies authentication.

NONE

public static final Encrypted.Migration NONE

During deserialization, when an unencrypted value is encountered it will either be ignored or cause data binding to fail (depending on other deserialization settings).

Method Details

values

public static Encrypted.Migration[] values()

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

Returns:

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

valueOf

public static Encrypted.Migration 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