Package com.couchbase.lite

Enum Class DocumentFlag

java.lang.Object

java.lang.Enum<DocumentFlag>

com.couchbase.lite.DocumentFlag

All Implemented Interfaces:

Serializable, Comparable<DocumentFlag>, java.lang.constant.Constable

public enum DocumentFlag
extends Enum<DocumentFlag>

The flags enum describing the replicated document.

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
ACCESS_REMOVED	The current access removed status of the document.
DELETED	The current deleted status of the document.

Method Summary

Modifier and Type	Method	Description
int	rawValue()
static DocumentFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentFlag[]	values()	Returns an array containing the constants of this enum class, 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

DELETED

public static final DocumentFlag DELETED

The current deleted status of the document.

ACCESS_REMOVED

public static final DocumentFlag ACCESS_REMOVED

The current access removed status of the document.

Method Details

values

public static DocumentFlag[] values()

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

Returns:

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

valueOf

public static DocumentFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

rawValue

public int rawValue()