/*
 * Copyright (C) 2006 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.webkit;

import android.content.ContentResolver;
import android.graphics.Bitmap;

/** {@collect.stats}
 * {@description.open}
 * Functions for manipulating the icon database used by WebView.
 * {@description.close}
 * {@property.open}
 * These functions require that a WebView be constructed before being invoked
 * and WebView.getIconDatabase() will return a WebIconDatabase object.
 * {@property.close}
 * {@description.open}
 * This
 * WebIconDatabase object is a single instance and all methods operate on that
 * single object.
 * {@description.close}
 */
public class WebIconDatabase {
    /** {@collect.stats}
	 * {@description.open}
     * Interface for receiving icons from the database.
	 * {@description.close}
     */
    public interface IconListener {
        /** {@collect.stats}
		 * {@description.open}
         * Called when the icon has been retrieved from the database and the
         * result is non-null.
		 * {@description.close}
         * @param url The url passed in the request.
         * @param icon The favicon for the given url.
         */
        public void onReceivedIcon(String url, Bitmap icon);
    }

    /** {@collect.stats}
	 * {@description.open}
     * Open a the icon database and store the icons in the given path.
	 * {@description.close}
     * @param path The directory path where the icon database will be stored.
     */
    public void open(String path) {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Close the shared instance of the icon database.
	 * {@description.close}
     */
    public void close() {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Removes all the icons in the database.
	 * {@description.close}
     */
    public void removeAllIcons() {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Request the Bitmap representing the icon for the given page
     * url. If the icon exists, the listener will be called with the result.
	 * {@description.close}
     * @param url The page's url.
     * @param listener An implementation on IconListener to receive the result.
     */
    public void requestIconForPageUrl(String url, IconListener listener) {
        throw new MustOverrideException();
    }

    /** {@collect.stats} {@hide}
     */
    public void bulkRequestIconForPageUrl(ContentResolver cr, String where,
            IconListener listener) {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Retain the icon for the given page url.
	 * {@description.close}
     * @param url The page's url.
     */
    public void retainIconForPageUrl(String url) {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Release the icon for the given page url.
	 * {@description.close}
     * @param url The page's url.
     */
    public void releaseIconForPageUrl(String url) {
        throw new MustOverrideException();
    }

    /** {@collect.stats}
	 * {@description.open}
     * Get the global instance of WebIconDatabase.
	 * {@description.close}
     * @return A single instance of WebIconDatabase. It will be the same
     *         instance for the current process each time this method is
     *         called.
     */
    public static WebIconDatabase getInstance() {
        // XXX: Must be created in the UI thread.
        return WebViewFactory.getProvider().getWebIconDatabase();
    }

    /** {@collect.stats}
     * @hide Only for use by WebViewProvider implementations
     */
    protected WebIconDatabase() {}
}