core/java/android/accounts/Future2.java

/*
 * Copyright (C) 2009 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package android.accounts;

import android.os.Bundle;

import java.io.IOException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

/**
 * An extension of {@link Future} that provides wrappers for {@link #get()} that handle the various
 * exceptions that  {@link #get()} may return and rethrows them as exceptions specific to
 * {@link AccountManager}.
 */
public interface Future2 extends Future<Bundle> {
    /**
     * Wrapper for {@link Future#get()}. If the get() throws {@link InterruptedException} then the
     * {@link Future2} is canceled and {@link OperationCanceledException} is thrown.
     * @return the {@link android.os.Bundle} that is returned by {@link Future#get()}
     * @throws OperationCanceledException if get() throws the unchecked
     * {@link java.util.concurrent.CancellationException} or if the {@link Future2} was interrupted.
     * @throws IOException if the request was unable to complete due to a network error
     * @throws AuthenticatorException if there was an error communicating with the
     * {@link AbstractAccountAuthenticator}.
     */
    Bundle getResult()
            throws OperationCanceledException, IOException, AuthenticatorException;

    /**
     * Wrapper for {@link Future#get()}. If the get() throws {@link InterruptedException} then the
     * {@link Future2} is canceled and {@link OperationCanceledException} is thrown.
     * @param timeout the maximum time to wait
     * @param unit the time unit of the timeout argument
     * @return the {@link android.os.Bundle} that is returned by {@link Future#get()}
     * @throws OperationCanceledException if get() throws the unchecked
     * {@link java.util.concurrent.CancellationException} or if the {@link Future2} was interrupted.
     * @throws IOException if the request was unable to complete due to a network error
     * @throws AuthenticatorException if there was an error communicating with the
     * {@link AbstractAccountAuthenticator}.
     */
    Bundle getResult(long timeout, TimeUnit unit)
            throws OperationCanceledException, IOException, AuthenticatorException;
}