com.urbanairship.api.experiments.model.Variant 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-2017.  Urban Airship and Contributors
 */

package com.urbanairship.api.experiments.model;


import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.urbanairship.api.schedule.model.Schedule;

import java.util.Optional;

/**
 * Defines a push that will be sent to a subset of an experiment's audience.
 */
public class Variant {

    private Optional name;
    private Optional description;
    private Optional schedule;
    private final VariantPushPayload variantPushPayload;
    private Optional weight;

    private Variant(Builder builder) {
        this.name = Optional.ofNullable(builder.name);
        this.description = Optional.ofNullable(builder.description);
        this.schedule = Optional.ofNullable(builder.schedule);
        this.variantPushPayload = builder.variantPushPayload;
        this.weight = Optional.ofNullable(builder.weight);
    }

    /**
     * Experiment builder
     * @return Builder
     */
    public static Builder newBuilder() {
        return new Builder();
    }

    /**
     * Get the name of the variant.
     * @return an Optional String
     */
    public Optional getName() {
        return name;
    }

    /**
     * Get the description of the experiment.
     * @return an Optional String
     */
    public Optional getDescription() {
        return description;
    }

    /**
     * Get the scheduled delivery time for the variant push.
     * @return an Optional Schedule object
     */
    public Optional getSchedule() {
        return schedule;
    }

    /**
     * Get the partial push notification associated with the variant. A partial push notification object
     * represents a Push payload, excepting the audience and device_types fields because they are defined in the
     * experiment object. Message Center messages are also not included in the partial push payload object.
     * @return VariantPushPayload object
     */
    public VariantPushPayload getVariantPushPayload() {
        return variantPushPayload;
    }

    /**
     * Get the weight of the variant. Defaults to 1. A whole number, representing the proportion of the audience
     * that will receive the variant.
     * @return an Optional Integer
     */
    public  Optional getWeight() {
        return weight;
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(name, description, schedule, variantPushPayload, weight);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        final Variant other = (Variant) obj;
        return Objects.equal(this.name, other.name)
                && Objects.equal(this.description, other.description)
                && Objects.equal(this.schedule, other.schedule)
                && Objects.equal(this.variantPushPayload, other.variantPushPayload)
                && Objects.equal(this.weight, other.weight);
    }

    @Override
    public String toString() {
        return "Variant{" +
                "name=" + name +
                ", description=" + description +
                ", schedule=" + schedule +
                ", variantPushPayload=" + variantPushPayload +
                ", weight=" + weight +
                '}';
    }

    /**
     * Variant Builder
     */
    public static class Builder {

        private String name;
        private String description;
        private Schedule schedule;
        private VariantPushPayload variantPushPayload;
        private Integer weight;

        /**
         * Set the variant name.
         * @param name String
         * @return Builder
         */
        public Builder setName(String name) {
            this.name = name;
            return this;
        }

        /**
         * Set the variant description.
         * @param description String
         * @return Builder
         */
        public Builder setDescription(String description) {
            this.description = description;
            return this;
        }

        /**
         * Set the time at which the variant push should be sent.
         * @param schedule Schedule
         * @return Builder
         */
        public Builder setSchedule(Schedule schedule) {
            this.schedule = schedule;
            return this;
        }

        /**
         * Set the partial push notification associated with the variant. A partial push notification object
         * represents a Push payload, excepting the audience and device_types fields because they are defined in the
         * experiment object. Message Center messages are not supported by the Experiments API so they are also not
         * included in the partial push payload object.
         * @param variantPushPayload VariantPushPayload
         * @return Builder
         */
        public Builder setPushPayload(VariantPushPayload variantPushPayload) {
            this.variantPushPayload = variantPushPayload;
            return this;
        }

        /**
         * Set the weight of the variant. Defaults to 1. A whole number, which we use to compute the proportion of the
         * audience that will receive this variant.
         * @param weight Integer
         * @return Builder
         */
        public Builder setWeight(Integer weight) {
            this.weight = weight;
            return this;
        }

        /**
         * Build a Variant object. Will fail if the following
         * precondition is not met.
         *          * 1. Partial push notification object must be specified.
         * 
         *
         * @throws NullPointerException if variantPushPayload is not set
         * @return Variant
         */
        public Variant build() {
            Preconditions.checkNotNull(variantPushPayload,
                    "'variant_push_payload' must be provided.");

            return new Variant(this);
        }
    }
}