/* * Copyright (C) 2005-2012 Alfresco Software Limited. * * This file is part of Alfresco * * Alfresco is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * Alfresco is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with Alfresco. If not, see . */ package org.alfresco.service.cmr.download; import java.io.Serializable; /** * Immutable data transfer object representing the status of a download. * * Provides the current status and an indication of the progress. Prgress is * measured by comparing done against total. Total gives an indication of the * total work, while done indicates how much has been completed. * * @author amiller */ public class DownloadStatus implements Serializable { private static final long serialVersionUID = 4513872550314507598L; public enum Status { PENDING, IN_PROGRESS, DONE, MAX_CONTENT_SIZE_EXCEEDED, CANCELLED } private long done; private long total; private long filesAddedCount; private long totalFileCount; private Status status; /** * Default constructor * @param status Current status of the download * @param done Done count * @param total Total to be de done * @param filesAddedCount Number of files added to the archive * @param totalFiles The number of files that will eventually be added to the archive */ public DownloadStatus(Status status, long done, long total, long filesAdded, long totalFiles) { this.status = status; this.done = done; this.total = total; this.filesAddedCount = filesAdded; this.totalFileCount = totalFiles; } /** * @return The percentage complete, calculated by multiplying done by 100 and dividing by total. */ public long getPercentageComplete() { return (done * 100) / total; } /** * @return true if status is DONE, false otherwise. */ public boolean isComplete() { return status == Status.DONE; } /** * @return the current status */ public Status getStatus() { return status; } /** * @return the current done count */ public long getDone() { return done; } /** * @return the total, to be done. */ public long getTotal() { return total; } /** * @return the total number of files in the download archive */ public long getTotalFiles() { return totalFileCount; } /** * @return the number of files added to the download archive * @return */ public long getFilesAdded() { return filesAddedCount; } }