com.couchbase.lite

Enum DocumentFlag

java.lang.Object

java.lang.Enum<DocumentFlag>

com.couchbase.lite.DocumentFlag

All Implemented Interfaces:

Serializable, Comparable<DocumentFlag>

public enum DocumentFlag
extends Enum<DocumentFlag>

The flags enum describing the replicated document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DocumentFlagsAccessRemoved The current access removed status of the document.
DocumentFlagsDeleted The current deleted status of the document.

Method Summary

Modifier and Type	Method and Description
int	rawValue()
static DocumentFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DocumentFlagsDeleted

public static final DocumentFlag DocumentFlagsDeleted

The current deleted status of the document.

DocumentFlagsAccessRemoved

public static final DocumentFlag DocumentFlagsAccessRemoved

The current access removed status of the document.

Method Detail

values

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

Returns:

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

valueOf

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

rawValue

public int rawValue()