NotificationMessage.java

package org.commcare.android.models.notifications;

import java.util.Date;

import android.os.Parcel;
import android.os.Parcelable;

/**
 * Notification messages are messages which are intended to be displayed to end
 * users in a best-effort per-session manner. This class is the wrapper model
 * to contain and parcelize message details. 
 * 
 * @author ctsims
 *
 */
public class NotificationMessage implements Parcelable {
    
    private String category, title, details, actions;
    private Date date;

    /*
     * (non-Javadoc)
     * @see android.os.Parcelable#describeContents()
     */
    @Override
    public int describeContents() {
        return 0;
    }

    /*
     * (non-Javadoc)
     * @see android.os.Parcelable#writeToParcel(android.os.Parcel, int)
     */
    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeStringArray(new String[] {category, title, details, actions});
        dest.writeLong(date.getTime());
    }

    public static final Parcelable.Creator<NotificationMessage> CREATOR = new Parcelable.Creator<NotificationMessage>() {

        /*
         * (non-Javadoc)
         * @see android.os.Parcelable.Creator#createFromParcel(android.os.Parcel)
         */
        @Override
        public NotificationMessage createFromParcel(Parcel source) {
            String[] array = new String[3];
            source.readStringArray(array);
            Date date = new Date(source.readLong());
            return new NotificationMessage(array[0], array[1], array[2], array[3], date);
            
        }

        /*
         * (non-Javadoc)
         * @see android.os.Parcelable.Creator#newArray(int)
         */
        @Override
        public NotificationMessage[] newArray(int size) {
            return new NotificationMessage[size]; 
        }
        
    };
    
    public NotificationMessage(String context, String title, String details, String action, Date date) {
        if(context == null || title == null || details == null || date == null) { 
            throw new NullPointerException("None of the arguments for creating a NotificationMessage may be null except for action");
        }
        this.category = context;
        this.title = title;
        this.details = details;
        this.actions = action;
        this.date = date;
    }

    public String getTitle() {
        return title;
    }

    public String getCategory() {
        return category;
    }

    public String getDetails() {
        return details;
    }
    
    /*
     * (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object o) {
        if(!(o instanceof NotificationMessage)) { return false; }
        NotificationMessage nm = (NotificationMessage)o;
        if(!nm.category.equals(category) && nm.title.equals(title) && nm.details.equals(details)) {
            return false;
        }
        if(nm.actions == null && this.actions != null) { return false; }
        if(nm.actions!= null && !nm.actions.equals(this.actions)) { return false; }
        
        //Date is excluded from equality
        //if(!nm.date.equals(this.date));
        
        return true;
    }

    public Date getDate() {
        return date;
    }

    public String getAction() {
        return actions;
    }
}