AppSearchResult

public final class AppSearchResult
extends Object

java.lang.Object
   ↳ androidx.appsearch.app.AppSearchResult<ValueType>


Information about the success or failure of an AppSearch call.

Summary

Constants

int RESULT_INTERNAL_ERROR

An internal error occurred within AppSearch, which the caller cannot address.

int RESULT_INVALID_ARGUMENT

The caller supplied invalid arguments to the call.

int RESULT_INVALID_SCHEMA

The caller supplied a schema which is invalid or incompatible with the previous schema.

int RESULT_IO_ERROR

An issue occurred reading or writing to storage.

int RESULT_NOT_FOUND

An entity the caller requested to interact with does not exist in the system.

int RESULT_OK

The call was successful.

int RESULT_OUT_OF_SPACE

Storage is out of space, and no more space could be reclaimed.

int RESULT_SECURITY_ERROR

The caller requested an operation it does not have privileges for.

int RESULT_UNKNOWN_ERROR

An unknown error occurred while processing the call.

Public methods

boolean equals(Object other)
String getErrorMessage()

Returns the error message associated with this result.

int getResultCode()

Returns one of the RESULT constants defined in AppSearchResult.

ValueType getResultValue()

Returns the result value associated with this result, if it was successful.

int hashCode()
boolean isSuccess()

Returns true if getResultCode() equals RESULT_OK.

static <ValueType> AppSearchResult<ValueType> newFailedResult(int resultCode, String errorMessage)

Creates a new failed AppSearchResult.

static <ValueType> AppSearchResult<ValueType> newSuccessfulResult(ValueType value)

Creates a new successful AppSearchResult.

String toString()

Inherited methods

Constants

RESULT_INTERNAL_ERROR

public static final int RESULT_INTERNAL_ERROR

An internal error occurred within AppSearch, which the caller cannot address. This error may be considered similar to IllegalStateException

Constant Value: 2 (0x00000002)

RESULT_INVALID_ARGUMENT

public static final int RESULT_INVALID_ARGUMENT

The caller supplied invalid arguments to the call. This error may be considered similar to IllegalArgumentException.

Constant Value: 3 (0x00000003)

RESULT_INVALID_SCHEMA

public static final int RESULT_INVALID_SCHEMA

The caller supplied a schema which is invalid or incompatible with the previous schema.

Constant Value: 7 (0x00000007)

RESULT_IO_ERROR

public static final int RESULT_IO_ERROR

An issue occurred reading or writing to storage. The call might succeed if repeated. This error may be considered similar to IOException.

Constant Value: 4 (0x00000004)

RESULT_NOT_FOUND

public static final int RESULT_NOT_FOUND

An entity the caller requested to interact with does not exist in the system.

Constant Value: 6 (0x00000006)

RESULT_OK

public static final int RESULT_OK

The call was successful.

Constant Value: 0 (0x00000000)

RESULT_OUT_OF_SPACE

public static final int RESULT_OUT_OF_SPACE

Storage is out of space, and no more space could be reclaimed.

Constant Value: 5 (0x00000005)

RESULT_SECURITY_ERROR

public static final int RESULT_SECURITY_ERROR

The caller requested an operation it does not have privileges for.

Constant Value: 8 (0x00000008)

RESULT_UNKNOWN_ERROR

public static final int RESULT_UNKNOWN_ERROR

An unknown error occurred while processing the call.

Constant Value: 1 (0x00000001)

Public methods

equals

public boolean equals (Object other)

Parameters
other Object

Returns
boolean

getErrorMessage

public String getErrorMessage ()

Returns the error message associated with this result.

If isSuccess() is true, the error message is always null. The error message may be null even if isSuccess() is false. See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is returned by getErrorMessage().

Returns
String

getResultCode

public int getResultCode ()

Returns one of the RESULT constants defined in AppSearchResult.

Returns
int

getResultValue

public ValueType getResultValue ()

Returns the result value associated with this result, if it was successful.

See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is placed in the result value by that call.

Returns
ValueType

Throws
IllegalStateException if this AppSearchResult is not successful.

hashCode

public int hashCode ()

Returns
int

isSuccess

public boolean isSuccess ()

Returns true if getResultCode() equals RESULT_OK.

Returns
boolean

newFailedResult

public static AppSearchResult<ValueType> newFailedResult (int resultCode, 
                String errorMessage)

Creates a new failed AppSearchResult.

Parameters
resultCode int

errorMessage String

Returns
AppSearchResult<ValueType>

newSuccessfulResult

public static AppSearchResult<ValueType> newSuccessfulResult (ValueType value)

Creates a new successful AppSearchResult.

Parameters
value ValueType

Returns
AppSearchResult<ValueType>

toString

public String toString ()

Returns
String