DownloadStatus.java

package de.danoeh.antennapodsp.service.download;

import de.danoeh.antennapodsp.feed.FeedFile;
import de.danoeh.antennapodsp.util.DownloadError;

import java.util.Date;

/**
 * Contains status attributes for one download
 */
public class DownloadStatus {
    /**
     * Downloaders should use this constant for the size attribute if necessary
     * so that the listadapters etc. can react properly.
     */
    public static final int SIZE_UNKNOWN = -1;

    // ----------------------------------- ATTRIBUTES STORED IN DB
    /**
     * Unique id for storing the object in database.
     */
    protected long id;
    /**
     * A human-readable string which is shown to the user so that he can
     * identify the download. Should be the title of the item/feed/media or the
     * URL if the download has no other title.
     */
    protected String title;
    protected DownloadError reason;
    /**
     * A message which can be presented to the user to give more information.
     * Should be null if Download was successful.
     */
    protected String reasonDetailed;
    protected boolean successful;
    protected Date completionDate;
    protected long feedfileId;
    /**
     * Is used to determine the type of the feedfile even if the feedfile does
     * not exist anymore. The value should be FEEDFILETYPE_FEED,
     * FEEDFILETYPE_FEEDIMAGE or FEEDFILETYPE_FEEDMEDIA
     */
    protected int feedfileType;

    // ------------------------------------ NOT STORED IN DB
    protected boolean done;
    protected boolean cancelled;

    /**
     * Constructor for restoring Download status entries from DB.
     */
    public DownloadStatus(long id, String title, long feedfileId,
                          int feedfileType, boolean successful, DownloadError reason,
                          Date completionDate, String reasonDetailed) {
        this.id = id;
        this.title = title;
        this.done = true;
        this.feedfileId = feedfileId;
        this.reason = reason;
        this.successful = successful;
        this.completionDate = (Date) completionDate.clone();
        this.reasonDetailed = reasonDetailed;
        this.feedfileType = feedfileType;
    }

    public DownloadStatus(DownloadRequest request, DownloadError reason,
                          boolean successful, boolean cancelled, String reasonDetailed) {
        if (request == null) {
            throw new IllegalArgumentException("request must not be null");
        }
        this.title = request.getTitle();
        this.feedfileId = request.getFeedfileId();
        this.feedfileType = request.getFeedfileType();
        this.reason = reason;
        this.successful = successful;
        this.cancelled = cancelled;
        this.reasonDetailed = reasonDetailed;
        this.completionDate = new Date();
    }

    /**
     * Constructor for creating new completed downloads.
     */
    public DownloadStatus(FeedFile feedfile, String title, DownloadError reason,
                          boolean successful, String reasonDetailed) {
        if (feedfile == null) {
            throw new IllegalArgumentException("feedfile must not be null");
        }

        this.title = title;
        this.done = true;
        this.feedfileId = feedfile.getId();
        this.feedfileType = feedfile.getTypeAsInt();
        this.reason = reason;
        this.successful = successful;
        this.completionDate = new Date();
        this.reasonDetailed = reasonDetailed;
    }

    /**
     * Constructor for creating new completed downloads.
     */
    public DownloadStatus(long feedfileId, int feedfileType, String title,
                          DownloadError reason, boolean successful, String reasonDetailed) {
        this.title = title;
        this.done = true;
        this.feedfileId = feedfileId;
        this.feedfileType = feedfileType;
        this.reason = reason;
        this.successful = successful;
        this.completionDate = new Date();
        this.reasonDetailed = reasonDetailed;
    }

    @Override
    public String toString() {
        return "DownloadStatus [id=" + id + ", title=" + title + ", reason="
                + reason + ", reasonDetailed=" + reasonDetailed
                + ", successful=" + successful + ", completionDate="
                + completionDate + ", feedfileId=" + feedfileId
                + ", feedfileType=" + feedfileType + ", done=" + done
                + ", cancelled=" + cancelled + "]";
    }

    public long getId() {
        return id;
    }

    public String getTitle() {
        return title;
    }

    public DownloadError getReason() {
        return reason;
    }

    public String getReasonDetailed() {
        return reasonDetailed;
    }

    public boolean isSuccessful() {
        return successful;
    }

    public Date getCompletionDate() {
        return (Date) completionDate.clone();
    }

    public long getFeedfileId() {
        return feedfileId;
    }

    public int getFeedfileType() {
        return feedfileType;
    }

    public boolean isDone() {
        return done;
    }

    public boolean isCancelled() {
        return cancelled;
    }

    public void setSuccessful() {
        this.successful = true;
        this.reason = DownloadError.SUCCESS;
        this.done = true;
    }

    public void setFailed(DownloadError reason, String reasonDetailed) {
        this.successful = false;
        this.reason = reason;
        this.reasonDetailed = reasonDetailed;
        this.done = true;
    }

    public void setCancelled() {
        this.successful = false;
        this.reason = DownloadError.ERROR_DOWNLOAD_CANCELLED;
        this.done = true;
        this.cancelled = true;
    }

    public void setCompletionDate(Date completionDate) {
        this.completionDate = (Date) completionDate.clone();
    }

    public void setId(long id) {
        this.id = id;
    }
}