com.apple.foundationdb.record.provider.foundationdb

Enum FDBRecordStoreBase.RecordExistenceCheck

java.lang.Object

java.lang.Enum<FDBRecordStoreBase.RecordExistenceCheck>

com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.RecordExistenceCheck

All Implemented Interfaces:

Serializable, Comparable<FDBRecordStoreBase.RecordExistenceCheck>

Enclosing interface:

FDBRecordStoreBase<M extends Message>

public static enum FDBRecordStoreBase.RecordExistenceCheck
extends Enum<FDBRecordStoreBase.RecordExistenceCheck>

Action to take if the record being saved does / does not already exist.

See Also:

FDBRecordStoreBase.saveRecordAsync(Message, RecordExistenceCheck)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR_IF_EXISTS Throw if the record already exists.
ERROR_IF_NOT_EXISTS Throw if the record does not already exist.
ERROR_IF_NOT_EXISTS_OR_RECORD_TYPE_CHANGED Throw if the record does not already exist or has a different record type.
ERROR_IF_RECORD_TYPE_CHANGED Throw if an existing record has a different record type.
NONE No special action.

Method Summary

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

NONE

public static final FDBRecordStoreBase.RecordExistenceCheck NONE

No special action. This corresponds to FDBRecordStoreBase.saveRecord(M)

ERROR_IF_EXISTS

public static final FDBRecordStoreBase.RecordExistenceCheck ERROR_IF_EXISTS

Throw if the record already exists. This corresponds to FDBRecordStoreBase.insertRecord(M)

See Also:

RecordAlreadyExistsException

ERROR_IF_NOT_EXISTS

public static final FDBRecordStoreBase.RecordExistenceCheck ERROR_IF_NOT_EXISTS

Throw if the record does not already exist.

See Also:

RecordDoesNotExistException

ERROR_IF_RECORD_TYPE_CHANGED

public static final FDBRecordStoreBase.RecordExistenceCheck ERROR_IF_RECORD_TYPE_CHANGED

Throw if an existing record has a different record type.

See Also:

RecordTypeChangedException

ERROR_IF_NOT_EXISTS_OR_RECORD_TYPE_CHANGED

public static final FDBRecordStoreBase.RecordExistenceCheck ERROR_IF_NOT_EXISTS_OR_RECORD_TYPE_CHANGED

Throw if the record does not already exist or has a different record type. This corresponds to FDBRecordStoreBase.updateRecord(M)

See Also:

RecordDoesNotExistException, RecordTypeChangedException

Method Detail

values

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

Returns:

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

valueOf

public static FDBRecordStoreBase.RecordExistenceCheck 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

errorIfExists

public boolean errorIfExists()

errorIfNotExists

public boolean errorIfNotExists()

errorIfTypeChanged

public boolean errorIfTypeChanged()