DocumentIdUtil

Kotlin |Java

public class DocumentIdUtil
extends Object

java.lang.Object
↳	android.app.appsearch.util.DocumentIdUtil

A util class with methods for working with document ids.

Summary

Public methods
`static String`	`createQualifiedId(String packageName, String databaseName, GenericDocument document)` Generates a qualified id based on package, database, and a `GenericDocument`.
`static String`	`createQualifiedId(String packageName, String databaseName, String namespace, String id)` Generates a qualified id based on package, database, namespace, and doc id.

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.

Public methods

createQualifiedId

Added in API level 34
Also in T Extensions 7

public static String createQualifiedId (String packageName, 
                String databaseName, 
                GenericDocument document)

Generates a qualified id based on package, database, and a GenericDocument.

Parameters
`packageName`	`String`: The package the document belongs to. This value cannot be `null`.
`databaseName`	`String`: The database containing the document. This value cannot be `null`.
`document`	`GenericDocument`: The document to generate a qualified id for. This value cannot be `null`.

Returns
`String`	the qualified id of a document. This value cannot be `null`.

See also:

createQualifiedId(String, String, String, String)

createQualifiedId

Added in API level 34
Also in T Extensions 7

public static String createQualifiedId (String packageName, 
                String databaseName, 
                String namespace, 
                String id)

Generates a qualified id based on package, database, namespace, and doc id.

A qualified id is a String referring to the combined package name, database name, namespace, and id of the document. It is useful for linking one document to another in order to perform a join operation.

Parameters
`packageName`	`String`: The package the document belongs to. This value cannot be `null`.
`databaseName`	`String`: The database containing the document. This value cannot be `null`.
`namespace`	`String`: The namespace of the document. This value cannot be `null`.
`id`	`String`: The id of the document. This value cannot be `null`.

Returns
`String`	the qualified id of a document This value cannot be `null`.