Added in API level 34

Summary: Constants | Methods | Inherited Methods

PropertyPath.PathSegment

Kotlin |Java

public static class PropertyPath.PathSegment
extends Object

java.lang.Object
↳	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
`int`	`NON_REPEATED_CARDINALITY` A marker variable to signify that a PathSegment represents a schema property that isn't indexed into.

Public methods
`static PropertyPath.PathSegment`	`create(String propertyName)` Creation method that accepts and validates a property name The property index is set to `NON_REPEATED_CARDINALITY`
`static PropertyPath.PathSegment`	`create(String propertyName, int propertyIndex)` Creation method that accepts and validates both a property name and the index into the property.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getPropertyIndex()` Returns the index into the property, or `NON_REPEATED_CARDINALITY` if this does not represent a PathSegment with an index.
`String`	`getPropertyName()` Returns the name of the property.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a path representing a PathSegment, either "foo" or "foo[1]"

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.

Constants

NON_REPEATED_CARDINALITY

Added in API level 34

public static final int NON_REPEATED_CARDINALITY

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.

Constant Value: -1 (0xffffffff)

Public methods

create

Added in API level 34

public static PropertyPath.PathSegment create (String propertyName)

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

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

create

Added in API level 34

public static PropertyPath.PathSegment create (String propertyName, 
                int propertyIndex)

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

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

Throws
`IllegalArgumentException`	if the property name or index is invalid.

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.

getPropertyIndex

Added in API level 34

public int getPropertyIndex ()

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

Returns
`int`

getPropertyName

Added in API level 34

public String getPropertyName ()

Returns the name of the property.

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

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.

toString

Added in API level 34

public String toString ()

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

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