cordova-plugin-local-notifications/src/android/notification/action/ActionGroup.java

/*
 * Apache 2.0 License
 *
 * Copyright (c) Sebastian Katzer 2017
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apache License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://opensource.org/licenses/Apache-2.0/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 */

package de.appplant.cordova.plugin.notification.action;

import android.content.Context;
import android.util.Log;

import org.json.JSONArray;
import org.json.JSONObject;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static android.os.Build.VERSION.SDK_INT;
import static android.os.Build.VERSION_CODES.N;

public final class ActionGroup {

    // Default action group id
    private static final String GENERAL_ACTION_GROUP = "DEFAULT_GROUP";

    // Saves all groups for later lookup.
    private static final Map<String, ActionGroup> groups =
            new HashMap<String, ActionGroup>();

    // The ID of the action group.
    private final String id;

    // List of actions
    private final Action[] actions;

    /**
     * Lookup the action groups with the specified group id.
     *
     * @param id The ID of the action group to find.
     *
     * @return Null if no group was found.
     */
    public static ActionGroup lookup(String id) {
        return groups.get(id);
    }

    /**
     * Register the action group for later lookup.
     *
     * @param group The action group to register.
     */
    public static void register (ActionGroup group) {
        if (!group.getId().equalsIgnoreCase(GENERAL_ACTION_GROUP)) {
            groups.put(group.getId(), group);
        }
    }

    /**
     * Creates an action group by parsing the specified action specs.
     *
     * @param spec The action group spec containing the id and list of actions.
     *
     * @return A new action group.
     */
    public static ActionGroup parse (Context context, JSONObject spec) {
        String id = spec.optString("actionGroupId", GENERAL_ACTION_GROUP);
        JSONArray list = spec.optJSONArray("actions");

        if (list == null || list.length() == 0)
            return null;

        List<Action> actions = new ArrayList<Action>(list.length());

        for (int i = 0; i < list.length(); i++) {
            JSONObject opts = list.optJSONObject(i);
            String type     = opts.optString("type", "button");

            if (type.equals("input") && SDK_INT < N) {
                Log.w("Action", "Type input is not supported");
                continue;
            }

            if (!(type.equals("button") || type.equals("input"))) {
                Log.w("Action", "Unknown type: " + type);
                continue;
            }

            actions.add(new Action(context, opts));
        }

        if (actions.isEmpty())
            return null;

        return new ActionGroup(id, actions.toArray(new Action[actions.size()]));
    }

    /**
     * Creates an action group.
     *
     * @param id      The ID of the group.
     * @param actions The list of actions.
     */
    private ActionGroup(String id, Action[] actions) {
        this.id      = id;
        this.actions = actions;
    }

    /**
     * Gets the action group id.
     */
    public String getId() {
        return id;
    }

    /**
     * Gets the action list.
     */
    public Action[] getActions() {
        return actions;
    }

}