Skip to content

Most visited

Recently visited

navigation
Added in API level 5

AccountManagerFuture

public interface AccountManagerFuture

android.accounts.AccountManagerFuture<V>


A AccountManagerFuture represents the result of an asynchronous AccountManager call. Methods are provided to check if the computation is complete, to wait for its completion, and to retrieve the result of the computation. The result can only be retrieved using method get when the computation has completed, blocking if necessary until it is ready. Cancellation is performed by the cancel method. Additional methods are provided to determine if the task completed normally or was cancelled. Once a computation has completed, the computation cannot be cancelled. If you would like to use a Future for the sake of cancellability but not provide a usable result, you can declare types of the form Future<?> and return null as a result of the underlying task.

Summary

Public methods

abstract boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel execution of this task.

abstract V getResult()

Accessor for the future result the AccountManagerFuture represents.

abstract V getResult(long timeout, TimeUnit unit)

Accessor for the future result the AccountManagerFuture represents.

abstract boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

abstract boolean isDone()

Returns true if this task completed.

Public methods

cancel

Added in API level 5
boolean cancel (boolean mayInterruptIfRunning)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isCancelled() will always return true if this method returned true.

Parameters
mayInterruptIfRunning boolean: true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete
Returns
boolean false if the task could not be cancelled, typically because it has already completed normally; true otherwise

getResult

Added in API level 5
V getResult ()

Accessor for the future result the AccountManagerFuture represents. This call will block until the result is available. In order to check if the result is available without blocking, one may call isDone() and isCancelled(). If the request that generated this result fails or is canceled then an exception will be thrown rather than the call returning normally.

Returns
V the actual result
Throws
OperationCanceledException if the request was canceled for any reason (including if it is forbidden by policy to modify an account (of that type))
AuthenticatorException if there was an error communicating with the authenticator or if the authenticator returned an invalid response
IOException if the authenticator returned an error response that indicates that it encountered an IOException while communicating with the authentication server

getResult

Added in API level 5
V getResult (long timeout, 
                TimeUnit unit)

Accessor for the future result the AccountManagerFuture represents. This call will block until the result is available. In order to check if the result is available without blocking, one may call isDone() and isCancelled(). If the request that generated this result fails or is canceled then an exception will be thrown rather than the call returning normally. If a timeout is specified then the request will automatically be canceled if it does not complete in that amount of time.

Parameters
timeout long: the maximum time to wait
unit TimeUnit: the time unit of the timeout argument. This must not be null.
Returns
V the actual result
Throws
OperationCanceledException if the request was canceled for any reason
AuthenticatorException if there was an error communicating with the authenticator or if the authenticator returned an invalid response
IOException if the authenticator returned an error response that indicates that it encountered an IOException while communicating with the authentication server

isCancelled

Added in API level 5
boolean isCancelled ()

Returns true if this task was cancelled before it completed normally.

Returns
boolean true if this task was cancelled before it completed

isDone

Added in API level 5
boolean isDone ()

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns
boolean true if this task completed
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.