AppSearchBatchResult.Builder

public static final class AppSearchBatchResult.Builder
extends Object

java.lang.Object
   ↳ androidx.appsearch.app.AppSearchBatchResult.Builder<KeyType, ValueType>


Builder for AppSearchBatchResult objects.

Summary

Public constructors

Builder()

Public methods

AppSearchBatchResult<KeyType, ValueType> build()

Builds an AppSearchBatchResult object from the contents of this AppSearchBatchResult.Builder.

Builder<KeyType, ValueType> setFailure(KeyType key, int resultCode, String errorMessage)

Associates the key with the provided failure code and error message.

Builder<KeyType, ValueType> setResult(KeyType key, AppSearchResult<ValueType> result)

Associates the key with the provided result.

Builder<KeyType, ValueType> setSuccess(KeyType key, ValueType value)

Associates the key with the provided successful return value.

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

build

public AppSearchBatchResult<KeyType, ValueType> build ()

Builds an AppSearchBatchResult object from the contents of this AppSearchBatchResult.Builder.

Returns
AppSearchBatchResult<KeyType, ValueType>

setFailure

public Builder<KeyType, ValueType> setFailure (KeyType key, 
                int resultCode, 
                String errorMessage)

Associates the key with the provided failure code and error message.

Any previous mapping for a key, whether success or failure, is deleted.

This is a convenience function which is equivalent to setResult(key, AppSearchResult.newFailedResult(resultCode, errorMessage)).

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name.

resultCode int: One of the constants documented in AppSearchResult.getResultCode().

errorMessage String: An optional string describing the reason or nature of the failure.

Returns
Builder<KeyType, ValueType>

setResult

public Builder<KeyType, ValueType> setResult (KeyType key, 
                AppSearchResult<ValueType> result)

Associates the key with the provided result.

Any previous mapping for a key, whether success or failure, is deleted.

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name.

result AppSearchResult: The result to associate with the key.

Returns
Builder<KeyType, ValueType>

setSuccess

public Builder<KeyType, ValueType> setSuccess (KeyType key, 
                ValueType value)

Associates the key with the provided successful return value.

Any previous mapping for a key, whether success or failure, is deleted.

This is a convenience function which is equivalent to setResult(key, AppSearchResult.newSuccessfulResult(value)).

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name.

value ValueType: An optional value to associate with the successful result of the operation being performed.

Returns
Builder<KeyType, ValueType>