Action.java

package com.batch.cordova.android.interop;

/**
 * Enum that wraps the supported action names.
 *
 * @author Arnaud Barisain-Monrose
 */
public enum Action
{
	SET_CONFIG("setConfig"),
	START("start"),
	STOP("stop"),
	DESTROY("destroy"),
	ON_NEW_INTENT("onNewIntent"),
    OPT_IN("optIn"),
    OPT_OUT("optOut"),
    OPT_OUT_AND_WIPE_DATA("optOutAndWipeData"),
    IS_OPTED_OUT("isOptedOut"),
    SET_FIND_INSTALLATION_ENABLED("setFindMyInstallationEnabled"),
    UPDATE_AUTOMATIC_DATA_COLLECTION("updateAutomaticDataCollection"),
    MESSAGING_SET_DO_NOT_DISTURB_ENABLED("messaging.setDoNotDisturbEnabled"),
    MESSAGING_SHOW_PENDING_MESSAGE("messaging.showPendingMessage"),
    PUSH_GET_LAST_KNOWN_TOKEN("push.getLastKnownPushToken"),
    PUSH_SET_GCM_SENDER_ID("push.setGCMSenderID"),
    PUSH_CLEAR_BADGE("push.clearBadge"),
    PUSH_DISMISS_NOTIFICATIONS("push.dismissNotifications"),
    PUSH_SET_IOSNOTIF_TYPES("push.setIOSNotifTypes"),
    PUSH_SET_ANDROIDNOTIF_TYPES("push.setAndroidNotifTypes"),
    PUSH_SET_IOSSHOW_FOREGROUND("push.setIOSShowForegroundNotifications"),
    PUSH_IOS_REFRESH_TOKEN("push.iOS.refreshToken"),
    PUSH_REQUEST_AUTHORIZATION("push.requestAuthorization"),
    PUSH_IOS_REQUEST_PROVISIONAL_AUTH("push.iOS.requestProvisionalAuthorization"),
	PROFILE_EDIT("profile.edit"),
	PROFILE_IDENTIFY("profile.identify"),
	PROFILE_TRACK_EVENT("profile.track.event"),
    PROFILE_TRACK_LOCATION("profile.track.location"),
	USER_DATA_DEBUG("user.data.debug"),// TODO: replace with showDebugActivity
	USER_GET_INSTALLATION_ID("user.getInstallationID"),
    USER_GET_LANGUAGE("user.getLanguage"),
    USER_GET_REGION("user.getRegion"),
    USER_GET_IDENTIFIER("user.getIdentifier"),
    USER_FETCH_ATTRIBUTES("user.fetch.attributes"),
    USER_FETCH_TAGS("user.fetch.tags"),
    USER_CLEAR_INSTALL_DATA("user.clearInstallationData"),
    INBOX_CREATE_INSTALLATION_FETCHER("inbox.createInstallationFetcher"),
    INBOX_CREATE_USER_FETCHER("inbox.createUserFetcher"),
    INBOX_RELEASE_FETCHER("inbox.releaseFetcher"),
    INBOX_FETCH_NEW_NOTIFICATIONS("inbox.fetchNewNotifications"),
    INBOX_FETCH_NEXT_PAGE("inbox.fetchNextPage"),
    INBOX_GET_FETCHED_NOTIFICATIONS("inbox.getFetchedNotifications"),
    INBOX_MARK_AS_READ("inbox.markAsRead"),
    INBOX_MARK_ALL_AS_READ("inbox.markAllAsRead"),
    INBOX_MARK_AS_DELETED("inbox.markAsDeleted"),
    INBOX_DISPLAY_LANDING_MESSAGE("inbox.displayLandingMessage");

    /**
     * Action name, the one passed as a paremeter in {@link com.batch.android.interop.Bridge}
     */
    private String name;

    /**
     * Init an action with its string representation
     */
    private Action(String name)
    {
        this.name = name;
    }

    /**
     * Get the name associated with this action
     */
    public String getName()
    {
        return name;
    }

    /**
     * Create an Action from its string name.
     *
     * @throws IllegalArgumentException Thrown when the supplied name doesn't match any known action
     * @param actionName Action name
     * @return Action
     */
    public static Action fromName(String actionName) throws IllegalArgumentException
    {
        for (Action parameterValue : values())
        {
            if (parameterValue.getName().equalsIgnoreCase(actionName))
            {
                return parameterValue;
            }
        }

        throw new IllegalArgumentException("Unknown action.");
    }
}