com.google.cloud.firestore

Class FieldPath

java.lang.Object

com.google.cloud.firestore.FieldPath

All Implemented Interfaces:

Comparable<FieldPath>

public abstract class FieldPath
extends Object
implements Comparable<FieldPath>

A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top level field in the document), or a list of field names (referring to a nested field in the document).

Constructor Summary

Constructors

Constructor and Description
FieldPath()

Method Summary

Modifier and Type	Method and Description
int	compareTo(FieldPath other)
static FieldPath	documentId() A special sentinel to refer to the ID of a document.
static FieldPath	of(String... fieldNames) Creates a FieldPath from the provided field names.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldPath

public FieldPath()

Method Detail

of

public static FieldPath of(@Nonnull
                           String... fieldNames)

Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.

Parameters:

fieldNames - A list of field names.

Returns:

A FieldPath that points to a field location in a document.

documentId

public static FieldPath documentId()

A special sentinel to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(@Nonnull
                     FieldPath other)

Specified by:

compareTo in interface Comparable<FieldPath>