com.urbanairship.api.push.model.notification.actions.Actions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
The Urban Airship Java client library
There is a newer version: 9.3.0
/*
 * Copyright (c) 2013-2016.  Urban Airship and Contributors
 */

package com.urbanairship.api.push.model.notification.actions;

import com.google.common.base.Objects;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.collect.ClassToInstanceMap;
import com.google.common.collect.ImmutableClassToInstanceMap;
import com.google.common.collect.Lists;
import com.google.common.collect.MutableClassToInstanceMap;
import com.google.common.collect.Sets;
import com.urbanairship.api.push.model.PushModelObject;

import java.util.List;
import java.util.Set;

/**
 * Represents the actions specified with the
 * notification. At least one action will
 * always be present.
 */
public class Actions extends PushModelObject {

    private final ClassToInstanceMap actions;

    private Actions(ClassToInstanceMap actions) {
        this.actions = ImmutableClassToInstanceMap.copyOf(actions);
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    public Builder toBuilder() {
        return newBuilder().mergeFrom(this);
    }

    public Optional getAppDefined() {
        return Optional.fromNullable(actions.getInstance(AppDefinedAction.class));
    }

    public Optional getAddTags() {
        return Optional.fromNullable(actions.getInstance(AddTagAction.class));
    }

    public Optional getRemoveTags() {
        return Optional.fromNullable(actions.getInstance(RemoveTagAction.class));
    }

    public Optional getOpenAction() {
        return Optional.fromNullable(actions.getInstance(Action.OpenAction.class));
    }

    public Iterable allActions() {
        return actions.values();
    }

    @Override
    public String toString() {
        return "Actions{" +
                "actions=" + actions +
                '}';
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(actions);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        final Actions other = (Actions) obj;
        return Objects.equal(this.actions, other.actions);
    }

    public static class Builder {

        private ClassToInstanceMap actions = MutableClassToInstanceMap.create();

        public Builder mergeFrom(Actions other) {
            actions.putAll(other.actions);
            return this;
        }

        public Builder addTags(AddTagAction addTags) {
            this.actions.put(AddTagAction.class, addTags);
            return this;
        }

        public Builder removeTags(RemoveTagAction removeTags) {
            this.actions.put(RemoveTagAction.class, removeTags);
            return this;
        }

        public Builder setOpen(Action.OpenAction open) {
            this.actions.put(Action.OpenAction.class, open);
            return this;
        }

        public Builder addAppDefined(AppDefinedAction appDefined) {
            this.actions.put(AppDefinedAction.class, appDefined);
            return this;
        }

        public Builder setShare(ShareAction shareAction) {
            actions.put(ShareAction.class, shareAction);
            return this;
        }

        public Actions build() {
            Preconditions.checkArgument(actions.size() != 0, "'actions' must contain at least one action.");

            for (Class action : actions.keySet()) {
                Preconditions.checkNotNull(actions.getInstance(action), action.getName() + " cannot have a null entry in actions.");
            }

            // Determine if the same tag is used both add and remove
            // actions.
            if (actions.containsKey(AddTagAction.class) && actions.containsKey(RemoveTagAction.class)) {
                TagActionData addTagData = actions.getInstance(AddTagAction.class).getValue();
                TagActionData removeTagData = actions.getInstance(RemoveTagAction.class).getValue();

                Set added = addTagData.isSingle() ?
                        Sets.newHashSet(addTagData.getSingleTag()) :
                        addTagData.getTagSet();
                Set removed = removeTagData.isSingle() ?
                        Sets.newHashSet(removeTagData.getSingleTag()) :
                        removeTagData.getTagSet();

                for (String addedTag : added) {
                    Preconditions.checkArgument(!removed.contains(addedTag), "The same tag cannot be specified in the 'add_tag' and 'remove'tag' actions at the same time: " + addedTag);
                }
            }

            // Check for app_defined collisions with top-level actions (or for the 'short name' associated
            // with an action).
            //
            // See the API v3 spec for complete details.
            if (actions.containsKey(AppDefinedAction.class) && actions.size() > 1) {
                List fieldNames = Lists.newArrayList(actions.getInstance(AppDefinedAction.class).getValue().fieldNames());
                for (Class key : actions.keySet()) {
                    if (key == AppDefinedAction.class) {
                        continue;
                    }

                    Action a = actions.getInstance(key);

                    String actionFieldName = ActionNameRegistry.INSTANCE.getFieldName(a.getActionType());

                    Preconditions.checkArgument(!fieldNames.contains(actionFieldName), "app_defined field '" + actionFieldName + "' collides with top level action.");

                    String actionShortName = ActionNameRegistry.INSTANCE.getShortName(a.getActionType());

                    Preconditions.checkArgument(!fieldNames.contains(actionShortName), "app_defined field '" + actionShortName + "' collides with top level action's 'short name'.");

                }
            }

            return new Actions(actions);
        }
    }
}