PathSegment

Kotlin |Java

open class PathSegment

kotlin.Any
↳	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.

If the property index is not set to 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
static Int	`NON_REPEATED_CARDINALITY` A marker variable to signify that a PathSegment represents a schema property that isn't indexed into.

Public methods
open static PropertyPath.PathSegment	`create(propertyName: String, propertyIndex: Int)` Creation method that accepts and validates both a property name and the index into the property.
open static PropertyPath.PathSegment	`create(propertyName: String)` Creation method that accepts and validates a property name
open Boolean	`equals(other: Any?)`
open Int	`getPropertyIndex()` Returns the index into the property, or `NON_REPEATED_CARDINALITY` if this does not represent a PathSegment with an index.
open String	`getPropertyName()`
open Int	`hashCode()`
open String	`toString()` Returns a path representing a PathSegment, either "foo" or "foo[1]"

Constants

NON_REPEATED_CARDINALITY

Added in API level 34

static val NON_REPEATED_CARDINALITY: 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.

Value: -1

Public methods

create

Added in API level 34

open 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 NON_REPEATED_CARDINALITY, as these are invalid array indices.

Parameters
`propertyName`	String: the name of the property This value cannot be `null`.
`propertyIndex`	Int: the index into the property

Return
`PropertyPath.PathSegment`	A new PathSegment This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	if the property name or index is invalid.

create

Added in API level 34

open static fun create(propertyName: String): PropertyPath.PathSegment

Creation method that accepts and validates a property name

The property index is set to NON_REPEATED_CARDINALITY

Parameters
`propertyName`	String: the name of the property This value cannot be `null`.

Return
`PropertyPath.PathSegment`	A new PathSegment This value cannot be `null`.

equals

Added in API level 34

open fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getPropertyIndex

Added in API level 34

open fun getPropertyIndex(): Int

Returns the index into the property, or NON_REPEATED_CARDINALITY if this does not represent a PathSegment with an index.

getPropertyName

Added in API level 34

open fun getPropertyName(): String

Return
`String`	the property name This value cannot be `null`.

hashCode

Added in API level 34

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 34

open fun toString(): String

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

Return
`String`	This value cannot be `null`.