Added in API level 34

Summary: Nested Classes | Ctors | Methods | Inherited Methods

PropertyPath

---

Kotlin |Java

public class PropertyPath
extends Object implements Iterable<PropertyPath.PathSegment>

java.lang.Object
↳	android.app.appsearch.PropertyPath

---

Represents a property path returned from searching the AppSearch Database.

One of the use cases for this class is when searching the AppSearch Database for the snippet matching use case. In this case you will get back SearchResult.MatchInfo objects that contain a property path signifying the location of a match within the database. This is a string that may look something like "foo.bar[0]". PropertyPath parses this string and breaks it up into a List of PathSegments. These may represent either a property or a property and a 0-based index into the property. For instance, "foo.bar[1]" would be parsed into a PathSegment with a property name of foo and a PathSegment with a property name of bar and an index of 1. This allows for easier manipulation of the property path.

This class won't perform any retrievals, it will only parse the path string. As such, it may not necessarily refer to a valid path in the database.

See also:

• SearchResult.MatchInfo

Summary

Nested classes
class	PropertyPath.PathSegment A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property.

Public constructors
PropertyPath(List<PropertyPath.PathSegment> pathList) Constructor directly accepting a path list
PropertyPath(String path) Constructor that parses a string representing the path to populate a List of PathSegments

Public methods
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
PropertyPath.PathSegment	get(int index) Returns the PathSegment at a specified index of the PropertyPath.
int	hashCode() Returns a hash code value for the object.
Iterator<PropertyPath.PathSegment>	iterator() Returns an iterator over the PathSegments within the PropertyPath
int	size() Returns the number of PathSegments in the PropertyPath.
String	toString() Returns a valid path string representing this PropertyPath

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface java.lang.Iterable default void forEach(Consumer<? super T> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. abstract Iterator<PropertyPath.PathSegment> iterator() Returns an iterator over elements of type T. default Spliterator<PropertyPath.PathSegment> spliterator() Creates a Spliterator over the elements described by this Iterable.

Public constructors

PropertyPath

Added in API level 34

public PropertyPath (List<PropertyPath.PathSegment> pathList)

Constructor directly accepting a path list

Parameters
pathList	List: a list of PathSegments This value cannot be null.

PropertyPath

Added in API level 34

public PropertyPath (String path)

Constructor that parses a string representing the path to populate a List of PathSegments

Parameters
path	String: the string to be validated and parsed into PathSegments This value cannot be null.

Throws
IllegalArgumentException	when the path is invalid or malformed

Public methods

equals

Added in API level 34

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

get

Added in API level 34

public PropertyPath.PathSegment get (int index)

Returns the PathSegment at a specified index of the PropertyPath.

Calling get(1) on a PropertyPath representing "foo.bar[1]" will return a PathSegment representing "bar[1]". PathSegments both with and without a property index of PathSegment#NON_REPEATED_CARDINALITY are retrieved the same.

Parameters
index	int: the position into the PropertyPath

Returns
PropertyPath.PathSegment	This value cannot be null.

Throws
ArrayIndexOutOfBoundsException	if index is not a valid index in the path list

hashCode

Added in API level 34

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

iterator

Added in API level 34

public Iterator<PropertyPath.PathSegment> iterator ()

Returns an iterator over the PathSegments within the PropertyPath

Returns
Iterator<PropertyPath.PathSegment>	This value cannot be null.

size

Added in API level 34

public int size ()

Returns the number of PathSegments in the PropertyPath.

Paths representing "foo.bar" and "foo[1].bar[1]" will have the same size, as a property and an index into that property are stored in one PathSegment.

Returns
int

toString

Added in API level 34

public String toString ()

Returns a valid path string representing this PropertyPath

Returns
String	This value cannot be null.