Package com.google.cloud.firestore

Class BasePath<B extends BasePath<B>>

java.lang.Object

com.google.cloud.firestore.BasePath<B>

All Implemented Interfaces:

Comparable<B>

Direct Known Subclasses:

FieldPath

public abstract class BasePath<B extends BasePath<B>>
extends Object
implements Comparable<B>

BasePath represents a path sequence in the Firestore database. It is composed of an ordered sequence of string segments.

Constructor Summary

Constructors

Constructor	Description
BasePath()

Method Summary

Modifier and Type	Method	Description
int	compareTo(B other)	Compare the current path lexicographically against another Path object.

Methods inherited from class java.lang.Object

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

Constructor Details

BasePath

public BasePath()

Method Details

compareTo

public int compareTo(@Nonnull
 B other)

Compare the current path lexicographically against another Path object.

Specified by:

compareTo in interface Comparable<B extends BasePath<B>>

Parameters:

other - The path to compare to.

Returns:

-1 if current is less than other, 1 if current greater than other, 0 if equal