/*
 * Copyright (C) 2024 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 com.android.launcher3.widget.picker;

import androidx.annotation.Nullable;
import androidx.annotation.StringRes;

import com.android.launcher3.R;

import java.util.Objects;

/**
 * A category of widget recommendations displayed in the widget picker (launched from "Widgets"
 * option in the pop-up opened on long press of launcher workspace).
 */
public class WidgetRecommendationCategory implements Comparable<WidgetRecommendationCategory> {
    public static WidgetRecommendationCategory DEFAULT_WIDGET_RECOMMENDATION_CATEGORY =
            new WidgetRecommendationCategory(
                    R.string.others_widget_recommendation_category_label, /*order=*/0);

    /** Resource id that holds the user friendly label for the category. */
    @StringRes
    public final int categoryTitleRes;
    /**
     * Relative order of this category with respect to other categories.
     *
     * <p>Category with lowest order is displayed first in the recommendations section.</p>
     */
    public final int order;

    public WidgetRecommendationCategory(@StringRes int categoryTitleRes, int order) {
        this.categoryTitleRes = categoryTitleRes;
        this.order = order;
    }

    @Override
    public int hashCode() {
        return Objects.hash(categoryTitleRes, order);
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (!(obj instanceof WidgetRecommendationCategory category)) {
            return false;
        }
        return categoryTitleRes == category.categoryTitleRes
                && order == category.order;
    }

    @Override
    public int compareTo(WidgetRecommendationCategory widgetRecommendationCategory) {
        return order - widgetRecommendationCategory.order;
    }
}
