components/omnibox/browser/android/java/src/org/chromium/components/omnibox/action/OmniboxPedal.java

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.components.omnibox.action;

import androidx.annotation.NonNull;
import androidx.annotation.VisibleForTesting;

import org.chromium.base.annotations.CalledByNative;
import org.chromium.components.omnibox.R;

/**
 * Omnibox Actions are additional actions associated with Omnibox Matches. For more information,
 * please check on OmniboxAction class definition on native side.
 */
public class OmniboxPedal extends OmniboxAction {
    @VisibleForTesting
    static final ChipIcon DINO_GAME_ICON = new ChipIcon(R.drawable.action_dino_game, true);
    /** The type of the underlying pedal. */
    public final @OmniboxPedalType int pedalId;

    @CalledByNative
    public OmniboxPedal(@NonNull String hint, @OmniboxPedalType int pedalId) {
        super(OmniboxActionType.PEDAL, hint,
                pedalId == OmniboxPedalType.PLAY_CHROME_DINO_GAME ? DINO_GAME_ICON : null);
        this.pedalId = pedalId;
    }

    /**
     * Cast supplied OmniboxAction to OmniboxPedal.
     * Requires the supplied input to be a valid instance of an OmniboxPedal whose
     * actionId is the PEDAL.
     */
    public static @NonNull OmniboxPedal from(@NonNull OmniboxAction action) {
        assert action != null;
        assert action.actionId == OmniboxActionType.PEDAL;
        assert action instanceof OmniboxPedal;
        return (OmniboxPedal) action;
    }
}