PropertyPath
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 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 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:
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 |
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 |
String
|
toString()
Returns a valid path string representing this PropertyPath |
Inherited methods | |
---|---|
Public constructors
PropertyPath
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
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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]". PathSegment
s 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
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 inequals
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 thehashCode
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 thehashCode
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
public Iterator<PropertyPath.PathSegment> iterator ()
Returns an iterator over the PathSegments within the PropertyPath
Returns | |
---|---|
Iterator<PropertyPath.PathSegment> |
This value cannot be null . |
size
public int size ()
Returns the number of 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 PathSegment
.
Returns | |
---|---|
int |
toString
public String toString ()
Returns a valid path string representing this PropertyPath
Returns | |
---|---|
String |
This value cannot be null . |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-05-15 UTC.