FieldPath

public final class FieldPath extends Object

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).

Public Method Summary

static FieldPath	documentId() Returns A special sentinel `FieldPath` to refer to the ID of a document.
boolean	equals(Object o)
int	hashCode()
static FieldPath	of(String... fieldNames) Creates a `FieldPath` from the provided field names.
String	toString()

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public static FieldPath documentId ()

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

public boolean equals (Object o)

public int hashCode ()

public static FieldPath of (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.