com.urbanairship.api.push.model.notification.android.Wearable Maven / Gradle / Ivy

Go to download
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.4.2
/*
 * Copyright (c) 2013-2016.  Urban Airship and Contributors
 */

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


import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.urbanairship.api.push.model.notification.Interactive;

import java.util.List;
import java.util.Optional;

/**
 * Represents an Android wearable object.
 */
public class Wearable {
    private final Optional backgroundImage;
    private final Optional interactive;
    private final Optional>> extraPages;

    /**
     * Return a new Wearable Builder.
     *
     * @return Builder
     */
    public static Builder newBuilder() {
        return new Builder();
    }

    private Wearable(Builder builder) {
        this.backgroundImage = Optional.ofNullable(builder.backgroundImage);
        this.interactive = Optional.ofNullable(builder.interactive);
        if (!builder.extraPages.build().isEmpty()) {
            this.extraPages = Optional.of(builder.extraPages.build());
        } else {
            this.extraPages = Optional.empty();
        }
    }

    /**
     * Get the background image URL.
     *
     * @return An optional string representing the background image URL.
     */
    public Optional getBackgroundImage() {
        return this.backgroundImage;
    }

    /**
     * Get the associated interactive payload.
     *
     * @return An optional Interactive object.
     */
    public Optional getInteractive() {
        return this.interactive;
    }

    /**
     * Get any associated extra pages.
     *
     * @return An optional set of maps.
     */
    public Optional>> getExtraPages() {
        return this.extraPages;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }

        Wearable that = (Wearable)obj;
        if (backgroundImage != null ? !backgroundImage.equals(that.backgroundImage) : that.backgroundImage != null) {
            return false;
        }
        if (interactive != null ? !interactive.equals(that.interactive) : that.interactive != null) {
            return false;
        }
        if (extraPages != null ? !extraPages.equals(that.extraPages) : that.extraPages != null) {
            return false;
        }
        return true;
    }

    @Override
    public int hashCode() {
        int result = (backgroundImage != null ? backgroundImage.hashCode() : 0);
        result = 31 * result + (interactive != null ? interactive.hashCode() : 0);
        result = 31 * result + (extraPages != null ? extraPages.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "Wearable{" +
                "backgroundImage=" + backgroundImage +
                ", interactive=" + interactive +
                ", extraPages=" + extraPages +
                '}';
    }


    public static class Builder {
        private String backgroundImage = null;
        private Interactive interactive = null;
        private ImmutableList.Builder> extraPages = ImmutableList.builder();

        private final static String TITLE = "title";
        private final static String ALERT = "alert";

        /**
         * Set the background image URL.
         *
         * @param value A string specifying the URL.
         * @return Builder
         */
        public Builder setBackgroundImage(String value) {
            this.backgroundImage = value;
            return this;
        }

        /**
         * Set the interactive payload.
         *
         * @param value An Interactive object.
         * @return Builder
         */
        public Builder setInteractive(Interactive value) {
            this.interactive = value;
            return this;
        }

        /**
         * Add an extra page to the wearable body.
         *
         * @param title String representing the page title.
         * @param alert String representing the page alert.
         * @return Builder
         */
        public Builder addExtraPage(String title, String alert) {
            ImmutableMap page = ImmutableMap.builder()
                    .put(TITLE, title)
                    .put(ALERT, alert)
                    .build();

            this.extraPages.add(page);
            return this;
        }

        /**
         * Add multiple extra pages to the extraPage list.
         *
         * @param extraPages An ImmutableMap of strings.
         * @return Builder
         */
        public Builder addAllExtraPages(List> extraPages) {
            this.extraPages.addAll(extraPages);
            return this;
        }

        /**
         * Build the Wearable object.
         *          * 1. At least one of backgroundImage, interactive, or extraPages must not be null.
         * 
         *
         * @return Wearable
         */
        public Wearable build() {
            Preconditions.checkArgument(
                    backgroundImage != null || interactive != null || !extraPages.build().isEmpty(),
                    "At least one of backgroundImage, interactive, or extraPages must not be null/empty."
            );

            return new Wearable(this);
        }
    }
}