Package com.google.cloud.firestore

Enum DocumentChange.Type

java.lang.Object

java.lang.Enum<DocumentChange.Type>

com.google.cloud.firestore.DocumentChange.Type

All Implemented Interfaces:

Serializable, Comparable<DocumentChange.Type>

Enclosing class:

DocumentChange

public static enum DocumentChange.Type
extends Enum<DocumentChange.Type>

An enumeration of snapshot diff types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDED	Indicates a new document was added to the set of documents matching the query.
MODIFIED	Indicates a document within the query was modified.
REMOVED	Indicates a document within the query was removed (either deleted or no longer matches the query.

Method Summary

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

ADDED

public static final DocumentChange.Type ADDED

Indicates a new document was added to the set of documents matching the query.

MODIFIED

public static final DocumentChange.Type MODIFIED

Indicates a document within the query was modified.

REMOVED

public static final DocumentChange.Type REMOVED

Indicates a document within the query was removed (either deleted or no longer matches the query.

Method Details

values

public static DocumentChange.Type[] 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 DocumentChange.Type 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