Package com.google.cloud.firestore

Class FieldPath

java.lang.Object
com.google.cloud.firestore.BasePath<FieldPath>
com.google.cloud.firestore.FieldPath
All Implemented Interfaces:
Comparable<FieldPath>
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).

  • Constructor Details

    • FieldPath

      public FieldPath()

  • Method Details

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

    • fromDotSeparatedString

      @InternalApi public static FieldPath fromDotSeparatedString(String field)
      Returns a field path from a dot separated string. Does not support escaping.

    • fromServerFormat

      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

    • toString

      public String toString()
      Overrides:
      toString in class Object