AppSearchException

Kotlin |Java

public class AppSearchException
extends Exception

java.lang.Object
↳	java.lang.Throwable
	↳	java.lang.Exception
		↳	android.app.appsearch.exceptions.AppSearchException

An exception thrown by AppSearchSession or a subcomponent.

These exceptions can be converted into a failed AppSearchResult for propagating to the client.

Summary

Public constructors
`AppSearchException(int resultCode)` Initializes an `AppSearchException` with no message.
`AppSearchException(int resultCode, String message)` Initializes an `AppSearchException` with a result code and message.
`AppSearchException(int resultCode, String message, Throwable cause)` Initializes an `AppSearchException` with a result code, message and cause.

Public methods
`int`	`getResultCode()` Returns the result code this exception was constructed with.
`<T> AppSearchResult<T>`	`toAppSearchResult()` Converts this `Exception` into a failed `AppSearchResult`.

Inherited methods

From class


        
          java.lang.Throwable

`final void`	`addSuppressed(Throwable exception)` Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()` Fills in the execution stack trace.
`Throwable`	`getCause()` Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
`String`	`getLocalizedMessage()` Creates a localized description of this throwable.
`String`	`getMessage()` Returns the detail message string of this throwable.
`StackTraceElement[]`	`getStackTrace()` Provides programmatic access to the stack trace information printed by `printStackTrace()`.
`final Throwable[]`	`getSuppressed()` Returns an array containing all of the exceptions that were suppressed, typically by the `try`-with-resources statement, in order to deliver this exception.
`Throwable`	`initCause(Throwable cause)` Initializes the cause of this throwable to the specified value.
`void`	`printStackTrace()` Prints this throwable and its backtrace to the standard error stream.
`void`	`printStackTrace(PrintWriter s)` Prints this throwable and its backtrace to the specified print writer.
`void`	`printStackTrace(PrintStream s)` Prints this throwable and its backtrace to the specified print stream.
`void`	`setStackTrace(StackTraceElement[] stackTrace)` Sets the stack trace elements that will be returned by `getStackTrace()` and printed by `printStackTrace()` and related methods.
`String`	`toString()` Returns a short description of this throwable.

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 constructors

AppSearchException

Added in API level 31

public AppSearchException (int resultCode)

Initializes an AppSearchException with no message.

Parameters

resultCode

int: One of the constants documented in AppSearchResult.getResultCode. Value is AppSearchResult.RESULT_OK, AppSearchResult.RESULT_UNKNOWN_ERROR, AppSearchResult.RESULT_INTERNAL_ERROR, AppSearchResult.RESULT_INVALID_ARGUMENT, AppSearchResult.RESULT_IO_ERROR, AppSearchResult.RESULT_OUT_OF_SPACE, AppSearchResult.RESULT_NOT_FOUND, AppSearchResult.RESULT_INVALID_SCHEMA, AppSearchResult.RESULT_SECURITY_ERROR, AppSearchResult.RESULT_DENIED, AppSearchResult.RESULT_RATE_LIMITED, AppSearchResult.RESULT_TIMED_OUT, or android.app.appsearch.AppSearchResult.RESULT_ALREADY_EXISTS

AppSearchException

Added in API level 31

public AppSearchException (int resultCode, 
                String message)

Initializes an AppSearchException with a result code and message.

Parameters

resultCode

message

String: The detail message (which is saved for later retrieval by the Throwable.getMessage() method). This value may be null.

AppSearchException

Added in API level 31

public AppSearchException (int resultCode, 
                String message, 
                Throwable cause)

Initializes an AppSearchException with a result code, message and cause.

Parameters
`resultCode`	`int`: One of the constants documented in `AppSearchResult.getResultCode`. Value is `AppSearchResult.RESULT_OK`, `AppSearchResult.RESULT_UNKNOWN_ERROR`, `AppSearchResult.RESULT_INTERNAL_ERROR`, `AppSearchResult.RESULT_INVALID_ARGUMENT`, `AppSearchResult.RESULT_IO_ERROR`, `AppSearchResult.RESULT_OUT_OF_SPACE`, `AppSearchResult.RESULT_NOT_FOUND`, `AppSearchResult.RESULT_INVALID_SCHEMA`, `AppSearchResult.RESULT_SECURITY_ERROR`, `AppSearchResult.RESULT_DENIED`, `AppSearchResult.RESULT_RATE_LIMITED`, `AppSearchResult.RESULT_TIMED_OUT`, or android.app.appsearch.AppSearchResult.RESULT_ALREADY_EXISTS
`message`	`String`: The detail message (which is saved for later retrieval by the `Throwable.getMessage()` method). This value may be `null`.
`cause`	`Throwable`: The cause (which is saved for later retrieval by the `Throwable.getCause()` method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Public methods

getResultCode

Added in API level 31

public int getResultCode ()

Returns the result code this exception was constructed with.

Returns

Returns
`int`	One of the constants documented in `AppSearchResult.getResultCode`. Value is `AppSearchResult.RESULT_OK`, `AppSearchResult.RESULT_UNKNOWN_ERROR`, `AppSearchResult.RESULT_INTERNAL_ERROR`, `AppSearchResult.RESULT_INVALID_ARGUMENT`, `AppSearchResult.RESULT_IO_ERROR`, `AppSearchResult.RESULT_OUT_OF_SPACE`, `AppSearchResult.RESULT_NOT_FOUND`, `AppSearchResult.RESULT_INVALID_SCHEMA`, `AppSearchResult.RESULT_SECURITY_ERROR`, `AppSearchResult.RESULT_DENIED`, `AppSearchResult.RESULT_RATE_LIMITED`, `AppSearchResult.RESULT_TIMED_OUT`, or android.app.appsearch.AppSearchResult.RESULT_ALREADY_EXISTS

int

One of the constants documented in AppSearchResult.getResultCode. Value is AppSearchResult.RESULT_OK, AppSearchResult.RESULT_UNKNOWN_ERROR, AppSearchResult.RESULT_INTERNAL_ERROR, AppSearchResult.RESULT_INVALID_ARGUMENT, AppSearchResult.RESULT_IO_ERROR, AppSearchResult.RESULT_OUT_OF_SPACE, AppSearchResult.RESULT_NOT_FOUND, AppSearchResult.RESULT_INVALID_SCHEMA, AppSearchResult.RESULT_SECURITY_ERROR, AppSearchResult.RESULT_DENIED, AppSearchResult.RESULT_RATE_LIMITED, AppSearchResult.RESULT_TIMED_OUT, or android.app.appsearch.AppSearchResult.RESULT_ALREADY_EXISTS

toAppSearchResult

Added in API level 31

public AppSearchResult<T> toAppSearchResult ()

Converts this Exception into a failed AppSearchResult.

Returns
`AppSearchResult<T>`	This value cannot be `null`.