All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.icesoft.faces.component.inputfile.FileInfo Maven / Gradle / Ivy

There is a newer version: 3.3.0
Show newest version
/*
 * Copyright 2004-2012 ICEsoft Technologies Canada Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an "AS
 * IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

package com.icesoft.faces.component.inputfile;

import com.icesoft.faces.util.CoreUtils;

import java.io.Serializable;
import java.io.File;

public class FileInfo implements Cloneable, Serializable {
    public static final int DEFAULT = 0;
    public static final int UPLOADING = 1;
    public static final int SAVED = 2;
    public static final int INVALID = 3;
    public static final int SIZE_LIMIT_EXCEEDED = 4;
    public static final int UNKNOWN_SIZE = 5;
    public static final int INVALID_NAME_PATTERN = 6;
    public static final int UNSPECIFIED_NAME = 7;
    public static final int INVALID_CONTENT_TYPE = 8;
    
    private int status = DEFAULT;
    private long size = 0;
    private String fileName = null;
    private String contentType = null;
    private File file = null;
    private int percent = 0;
    private Exception exception = null;
    private boolean preUpload = false;
    private boolean postUpload = false;

    public FileInfo() {
        super();
    }
    
    public String getContentType() {
        return contentType;
    }

    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    public String getFileName() {
        return fileName;
    }

    public void setFileName(String fileName) {
        this.fileName = fileName;
    }
    
    public File getFile() {
        return file;
    }
    
    public void setFile(File file) {
        this.file = file;
    }
    
    public String getPhysicalPath() {
        if (file != null) {
            return file.getAbsolutePath();
        }
        return null;
    }

    public int getStatus() {
        return status;
    }
    
    public void setStatus(int status) {
        this.status = status;
    }
    
    public long getSize() {
        return size;
    }

    public void setSize(long size) {
        this.size = size;
    }

    public int getPercent() {
        return percent;
    }

    public void setPercent(int percent) {
        this.percent = percent;
    }

    /**
     * It used to be that for commons-upload FileUploadIOException exceptions,
     * FileInfo.getException() would return a FileUploadIOException, and
     * InputFile.getUploadException() would return the actual useful
     * subclass, gotten from FileInfo.getException().getCause(). Now, they
     * both return the same useful subclass.
     */
    public Exception getException() {
        return exception;
    }

    public void setException(Exception exception) {
        this.exception = exception;
    }

    /**
     * InputFile can now send progress events before the file upload begins,
     * and after it has completed, to facilitate synchronous mode, so that
     * applications may turn on and off an indeterminate progress bar during
     * the file upload, since they can't push incremental progress updates.
     * @return If this lifecycle is before the file upload begins.
     */
    public boolean isPreUpload() {
        return preUpload;
    }
    
    public void setPreUpload(boolean pre) {
        preUpload = pre;
    }
    
    /**
     * InputFile can now send progress events before the file upload begins,
     * and after it has completed, to facilitate synchronous mode, so that
     * applications may turn on and off an indeterminate progress bar during
     * the file upload, since they can't push incremental progress updates.
     * @return If this lifecycle is after the file upload finishes.
     */
    public boolean isPostUpload() {
        return postUpload;
    }
    
    public void setPostUpload(boolean post) {
        postUpload = post;
    }

    /**
     * @return If the file was successfully uploaded
     */
    public boolean isSaved() {
        return status == SAVED;
    }
    
    /**
     * @return If the file upload operation has finished, either successfully, or due to a failure
     */
    public boolean isFinished() {
        return status >= SAVED;
    }
    
    /**
     * @return If the file upload operation failed
     */
    public boolean isFailed() {
        return (status >= INVALID && status <= INVALID_CONTENT_TYPE);
    }
    
    public Object clone() {
        FileInfo fi = new FileInfo();
        fi.status       = this.status;
        fi.size         = this.size;
        fi.fileName     = this.fileName;
        fi.contentType  = this.contentType;
        fi.file         = this.file;
        fi.percent      = this.percent;
        fi.exception    = this.exception;
        fi.preUpload    = this.preUpload;
        fi.postUpload   = this.postUpload;
        return fi;
    }
    
    public String toString() {
        return
            "FileInfo: {" +
            "\n  percent=" + percent +
            ",\n  preUpload=" + preUpload +
            ",\n  postUpload=" + postUpload +
            ",\n  exception=" + exception +
            ",\n  fileName=" + fileName +
            ",\n  file=" + file +
            ",\n  physicalPath=" + getPhysicalPath() +
            ",\n  contentType=" + contentType +
            ",\n  size=" + size +
            ",\n  status=" + status +
            "\n}";        
    }

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

        FileInfo fileInfo = (FileInfo) o;

        if (status != fileInfo.status) return false;
        if (percent != fileInfo.percent) return false;
        if (postUpload != fileInfo.postUpload) return false;
        if (preUpload != fileInfo.preUpload) return false;
        if (size != fileInfo.size) return false;
        if (contentType != null ? !contentType.equals(fileInfo.contentType) : fileInfo.contentType != null)
            return false;
//        if (exception != null ? !exception.equals(fileInfo.exception) : fileInfo.exception != null) return false;
        if (!CoreUtils.throwablesEqual(exception, fileInfo.exception)) return false;
        if (fileName != null ? !fileName.equals(fileInfo.fileName) : fileInfo.fileName != null) return false;
        if (file != null ? !file.equals(fileInfo.file) : fileInfo.file != null)
            return false;

        return true;
    }

    public int hashCode() {
        int result;
        result = (int) (size ^ (size >>> 32));
        result = 31 * result + status;
        result = 31 * result + (fileName != null ? fileName.hashCode() : 0);
        result = 31 * result + (contentType != null ? contentType.hashCode() : 0);
        result = 31 * result + (file != null ? file.hashCode() : 0);
        result = 31 * result + percent;
        result = 31 * result + (exception != null ? exception.hashCode() : 0);
        result = 31 * result + (preUpload ? 1 : 0);
        result = 31 * result + (postUpload ? 1 : 0);
        return result;
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy