gecko/mobile/android/base/home/SearchEngine.java

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.gecko.home;

import org.mozilla.gecko.gfx.BitmapUtils;

import org.json.JSONException;
import org.json.JSONObject;

import android.graphics.Bitmap;
import android.util.Log;

import java.util.ArrayList;
import java.util.List;

public class SearchEngine {
    public static final String LOG_TAG = "GeckoSearchEngine";

    public final String name;             // Never null.
    public final String identifier;       // Can be null.

    private final Bitmap icon;
    private volatile List<String> suggestions = new ArrayList<String>();   // Never null.

    public SearchEngine(JSONObject engineJSON) throws JSONException {
        if (engineJSON == null) {
            throw new IllegalArgumentException("Can't instantiate SearchEngine from null JSON.");
        }

        this.name = getString(engineJSON, "name");
        if (this.name == null) {
            throw new IllegalArgumentException("Cannot have an unnamed search engine.");
        }

        this.identifier = getString(engineJSON, "identifier");

        final String iconURI = getString(engineJSON, "iconURI");
        if (iconURI == null) {
            Log.w(LOG_TAG, "iconURI is null for search engine " + this.name);
            this.icon = null;
            return;
        }
        this.icon = BitmapUtils.getBitmapFromDataURI(iconURI);
    }

    private static String getString(JSONObject data, String key) throws JSONException {
        if (data.isNull(key)) {
            return null;
        }
        return data.getString(key);
    }

    /**
     * @return a non-null string suitable for use by FHR.
     */
    public String getEngineIdentifier() {
        if (this.identifier != null) {
            return this.identifier;
        }
        if (this.name != null) {
            return "other-" + this.name;
        }
        return "other";
    }

    public boolean hasSuggestions() {
        return !this.suggestions.isEmpty();
    }

    public int getSuggestionsCount() {
        return this.suggestions.size();
    }

    public Iterable<String> getSuggestions() {
        return this.suggestions;
    }

    public void setSuggestions(List<String> suggestions) {
        if (suggestions == null) {
            this.suggestions = new ArrayList<String>();
            return;
        }
        this.suggestions = suggestions;
    }

    public Bitmap getIcon() {
        return this.icon;
    }
}