Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 7](https://developer.android.com/sdkExtensions) Summary: [Nested Classes](https://developer.android.com/reference/android/app/appsearch/PropertyPath#nestedclasses) \| [Ctors](https://developer.android.com/reference/android/app/appsearch/PropertyPath#pubctors) \| [Methods](https://developer.android.com/reference/android/app/appsearch/PropertyPath#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/appsearch/PropertyPath#inhmethods)

# PropertyPath

*** ** * ** ***

` public class PropertyPath `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/lang/Iterable<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment> `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appsearch.PropertyPath |

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/android/app/appsearch/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\]". `https://developer.android.com/reference/android/app/appsearch/PropertyPath` parses this string and breaks it up into a List of `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment`s. 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 `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` with a property name of foo and a `https://developer.android.com/reference/android/app/appsearch/PropertyPath.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:**

- `https://developer.android.com/reference/android/app/appsearch/SearchResult.MatchInfo`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#PropertyPath(java.lang.String)(https://developer.android.com/reference/java/lang/String path) ` Constructor that parses a string representing the path to populate a List of PathSegments |
| ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#PropertyPath(java.util.List<android.app.appsearch.PropertyPath.PathSegment>)(https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment> pathList) ` Constructor directly accepting a path list |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#get(int)(int index) ` Returns the `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` at a specified index of the PropertyPath. |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment>` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#iterator()() ` Returns an iterator over the PathSegments within the PropertyPath |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#size()() ` Returns the number of `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment`s in the PropertyPath. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/app/appsearch/PropertyPath#toString()() ` Returns a valid path string representing this PropertyPath |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/java/lang/Iterable ` ` default void` ` https://developer.android.com/reference/java/lang/Iterable#forEach(java.util.function.Consumer<?%20super%20T>)(https://developer.android.com/reference/java/util/function/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 https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment>` ` https://developer.android.com/reference/java/lang/Iterable#iterator()() `

Returns an iterator over elements of type `T`.
` default https://developer.android.com/reference/java/util/Spliterator<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment>` ` https://developer.android.com/reference/java/lang/Iterable#spliterator()() `

Creates a `https://developer.android.com/reference/java/util/Spliterator` over the elements described by this `Iterable`.

## Public constructors

### PropertyPath

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 7](https://developer.android.com/sdkExtensions)

```
public PropertyPath (String path)
```

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

<br />

| Parameters ||
|---|---|
| `path` | `String`: the string to be validated and parsed into PathSegments. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | when the path is invalid or malformed |

### PropertyPath

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 7](https://developer.android.com/sdkExtensions)

```
public PropertyPath (List<PropertyPath.PathSegment> pathList)
```

Constructor directly accepting a path list

<br />

| Parameters ||
|---|---|
| `pathList` | `List`: a list of PathSegments. This value cannot be `null`. <br /> |

## Public methods

### equals

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `o` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### get

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 7](https://developer.android.com/sdkExtensions)

```
public PropertyPath.PathSegment get (int index)
```

Returns the `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` at a specified index of the PropertyPath.

Calling `get(1)` on a `https://developer.android.com/reference/android/app/appsearch/PropertyPath` representing "foo.bar\[1\]" will return a `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` representing "bar\[1\]". `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment`s both with and without a property index of `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY` are retrieved the same.

<br />

| Parameters ||
|---|---|
| `index` | `int`: the position into the PropertyPath <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment` | This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/ArrayIndexOutOfBoundsException` | if index is not a valid index in the path list |

### hashCode

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### iterator

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Iterator<PropertyPath.PathSegment> iterator ()
```

Returns an iterator over the PathSegments within the PropertyPath

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment>` | This value cannot be `null`. <br /> |

### size

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 7](https://developer.android.com/sdkExtensions)

```
public int size ()
```

Returns the number of `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment`s 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 `https://developer.android.com/reference/android/app/appsearch/PropertyPath.PathSegment`.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### toString

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a valid path string representing this PropertyPath

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |