public abstract class FieldPath extends BasePath<FieldPath> 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).
Implements
Comparable<FieldPath>Static Methods
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.
| Returns | |
|---|---|
| Type | Description |
FieldPath |
|
fromServerFormat(String path)
public static FieldPath fromServerFormat(String path)Creates a FieldPath from a server-encoded field path.
Copied from Firebase Android SDK: https://github.com/firebase/firebase-android-sdk/blob/2d3b2be7d2d00d693eb74986f20a6265c918848f/firebase-firestore/src/main/java/com/google/firebase/firestore/model/FieldPath.java#L47
| Parameter | |
|---|---|
| Name | Description |
path |
String |
| Returns | |
|---|---|
| Type | Description |
FieldPath |
|
of(String[] fieldNames)
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.
| Parameter | |
|---|---|
| Name | Description |
fieldNames |
String[]A list of field names. |
| Returns | |
|---|---|
| Type | Description |
FieldPath |
A |
Constructors
FieldPath()
public FieldPath()Methods
toString()
public String toString()| Returns | |
|---|---|
| Type | Description |
String |
|