# PropertyPath.PathSegment

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/app/PropertyPath.java+class:androidx.appsearch.app.PropertyPath.PathSegment) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
class PropertyPath.PathSegment
```

<br />

*** ** * ** ***

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

If the property index is not set to `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY()`, this represents a schema property with the "repeated" cardinality, or a path like "foo\[1\]". Otherwise, this represents a schema property that could have any cardinality, or a path like "foo".

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY() = -1` A marker variable to signify that a PathSegment represents a schema property that isn't indexed into. |

| ### Public functions |
|---|---|
| `java-static https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#create(java.lang.String)(propertyName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Creation method that accepts and validates a property name |
| `java-static https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#create(java.lang.String,int)(propertyName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, propertyIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Creation method that accepts and validates both a property name and the index into the property. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#equals(java.lang.Object)(o: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#getPropertyIndex()()` Returns the index into the property, or `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY()` if this does not represent a PathSegment with an index. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#getPropertyName()()` Returns the name of the property. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#hashCode()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#toString()()` Returns a path representing a PathSegment, either "foo" or "foo\[1\]" |

## Constants

### NON_REPEATED_CARDINALITY

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
const val NON_REPEATED_CARDINALITY = -1: Int
```

A marker variable to signify that a PathSegment represents a schema property that isn't indexed into. The value is chosen to be invalid if used as an array index.

## Public functions

### create

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
java-static fun create(propertyName: String): PropertyPath.PathSegment
```

Creation method that accepts and validates a property name

The property index is set to `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY()`

| Parameters |
|---|---|
| `propertyName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the name of the property |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment` | A new PathSegment |

### create

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
java-static fun create(propertyName: String, propertyIndex: Int): PropertyPath.PathSegment
```

Creation method that accepts and validates both a property name and the index into the property.

The property name may not be blank. It also may not contain square brackets or dots, as they are control characters in property paths. The index into the property may not be negative, unless it is `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY()`, as these are invalid array indices.

| Parameters |
|---|---|
| `propertyName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the name of the property |
| `propertyIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | the index into the property |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment` | A new PathSegment |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException.html` | if the property name or index is invalid. |

### equals

```
fun equals(o: Any?): Boolean
```

### getPropertyIndex

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getPropertyIndex(): Int
```

Returns the index into the property, or `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment#NON_REPEATED_CARDINALITY()` if this does not represent a PathSegment with an index.

### getPropertyName

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getPropertyName(): String
```

Returns the name of the property.

### hashCode

```
fun hashCode(): Int
```

### toString

```
fun toString(): String
```

Returns a path representing a PathSegment, either "foo" or "foo\[1\]"