com.github.kaiwinter.androidremotenotifications.model.impl.NotificationConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-remote-notifications Show documentation
Pulls notifications from a remote JSON file and shows them in your app.
There is a newer version: 1.1.5
Show newest version
package com.github.kaiwinter.androidremotenotifications.model.impl;

import com.github.kaiwinter.androidremotenotifications.model.ExecutionPolicy;

import java.util.Date;

/**
 * Stores configurations for a Notification e.g. when and how often it is shown and on which app versions.
 */
public final class NotificationConfiguration {

    /**
     * From this date on the notification will be shown. If null notification will be shown immediately (if
     * {@link ExecutionPolicy} strikes).
     */
    private Date startShowingDate;

    /**
     * Defines when to show the notification. If null the notification will be shown
     * {@link ExecutionPolicy#ALWAYS}.
     * 
     * This will be evaluated only after {@link #startShowingDate} (if not null).
     */
    private ExecutionPolicy executionPolicy;

    /**
     * Defines how many times the notification is shown in regards to executionPolicy (null=infinite).
     */
    private Integer numberOfTotalViews;

    /**
     * The app version on which the notification is shown. If null notification will be shown on all
     * versions.
     */
    private VersionCodePolicy versionCodePolicy;

    /**
     * @return the date to start showing the notification
     */
    public Date getStartShowingDate() {
        return startShowingDate;
    }

    /**
     * Set the date from which the notification will be shown. If null notification will be shown immediately (if
     * {@link ExecutionPolicy} strikes).
     *
     * @param startShowingDate the date to start showing the notification
     */
    public void setStartShowingDate(Date startShowingDate) {
        this.startShowingDate = startShowingDate;
    }

    /**
     * Returns when to show the notification.
     *
     * @return when to show the notification
     */
    public ExecutionPolicy getExecutionPolicy() {
        return executionPolicy;
    }

    /**
     * Sets the {@link ExecutionPolicy} when to show the notification. If null the notification will be shown
     * {@link ExecutionPolicy#ALWAYS}. This will be evaluated only after {@link #startShowingDate} (if not null).
     *
     * @param executionPolicy when to show the notification
     */
    public void setExecutionPolicy(ExecutionPolicy executionPolicy) {
        this.executionPolicy = executionPolicy;
    }

    /**
     * Returns the number of times the notification is shown in regards to executionPolicy (null=infinite).
     *
     * @return the number of times the notification is shown.
     */
    public Integer getNumberOfTotalViews() {
        return numberOfTotalViews;
    }

    /**
     * Sets the number of times the notification is shown in regards to executionPolicy (null=infinite).
     *
     * @param numberOfTotalViews the number of times the notification is shown in regards to executionPolicy (null=infinite).
     */
    public void setNumberOfTotalViews(Integer numberOfTotalViews) {
        this.numberOfTotalViews = numberOfTotalViews;
    }

    /**
     * Returns the app version on which the notification is shown. If null notification will be shown on all
     * versions.
     *
     * @return the {@link VersionCodePolicy}
     */
    public VersionCodePolicy getVersionCodePolicy() {
        return versionCodePolicy;
    }

    /**
     * Sets the app version on which the notification is shown. If null notification will be shown on all
     * versions.
     *
     * @param versionCodePolicy the {@link VersionCodePolicy} to restrict the app versions
     */
    public void setVersionCodePolicy(VersionCodePolicy versionCodePolicy) {
        this.versionCodePolicy = versionCodePolicy;
    }

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

        NotificationConfiguration that = (NotificationConfiguration) o;

        if (startShowingDate != null ? !startShowingDate.equals(that.startShowingDate) : that.startShowingDate != null)
            return false;
        if (executionPolicy != that.executionPolicy) return false;
        if (numberOfTotalViews != null ? !numberOfTotalViews.equals(that.numberOfTotalViews) : that.numberOfTotalViews != null)
            return false;
        return !(versionCodePolicy != null ? !versionCodePolicy.equals(that.versionCodePolicy) : that.versionCodePolicy != null);

    }

    @Override
    public int hashCode() {
        int result = startShowingDate != null ? startShowingDate.hashCode() : 0;
        result = 31 * result + (executionPolicy != null ? executionPolicy.hashCode() : 0);
        result = 31 * result + (numberOfTotalViews != null ? numberOfTotalViews.hashCode() : 0);
        result = 31 * result + (versionCodePolicy != null ? versionCodePolicy.hashCode() : 0);
        return result;
    }
}