NosTransferInfo.java

浏览该文件的文档.

package com.netease.nimlib.sdk.nos.model;

import com.netease.nimlib.sdk.nos.constant.NosTransferStatus;

import java.io.Serializable;

/**
 * NOS文件传输信息
 */
public class NosTransferInfo implements Serializable {

    public enum TransferType {
        UPLOAD,
        DOWNLOAD
    }

    /**
     * 上传or下载
     */
    protected TransferType transferType;

    /**
     * 文件路径
     */
    protected String path;

    /**
     * 文件大小
     */
    protected long size;

    /**
     * 文件内容的MD5
     */
    protected String md5;

    /**
     * 文件下载地址
     */
    protected String url;

    /**
     * 文件后缀名
     */
    protected String extension;

    /**
     * 文件传输状态
     */
    protected NosTransferStatus status = NosTransferStatus.def;

    /**
     * 获取文件本地路径
     *
     * @return 文件路径
     */
    public String getPath() {
        return path;
    }

    /**
     * 设置文件路径
     *
     * @param path 文件路径
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * 获取文件大小，单位为byte
     *
     * @return 文件大小
     */
    public long getSize() {
        return size;
    }

    /**
     * 设置文件大小，单位为byte
     *
     * @param size 文件大小
     */
    public void setSize(long size) {
        this.size = size;
    }

    /**
     * 获取文件内容MD5
     *
     * @return 内容MD5
     */
    public String getMd5() {
        return md5;
    }

    /**
     * 设置文件内容MD5
     *
     * @param md5 内容MD5
     */
    public void setMd5(String md5) {
        this.md5 = md5;
    }

    /**
     * 获取文件在服务器上的下载url。若文件还未上传，返回null
     *
     * @return 源站url
     */
    public String getUrl() {
        return url;
    }

    /**
     * @param url
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * 获取文件后缀名
     *
     * @return 后缀名
     */
    public String getExtension() {
        return extension;
    }

    /**
     * 设置文件后缀名
     *
     * @param extension 后缀名
     */
    public void setExtension(String extension) {
        this.extension = extension;
    }

    /**
     * 获取文件传输当前状态
     *
     * @return 当前文件传输状态
     */
    public NosTransferStatus getStatus() {
        return status;
    }

    /**
     * 设置文件传输当前状态
     *
     * @param status 文件传输状态枚举
     */
    public void setStatus(NosTransferStatus status) {
        this.status = status;
    }

    /**
     * 返回当前传输是上传还是下载
     *
     * @return 上传or下载
     */
    public TransferType getTransferType() {
        return transferType;
    }

    /**
     * 设置当前传输是上传还是下载
     *
     * @param transferType 上传or下载
     */
    public void setTransferType(TransferType transferType) {
        this.transferType = transferType;
    }

    /**
     * 返回当前文件传输的唯一标识
     *
     * @return 如果是上传文件，返回本地路径；如果是下载文件，返回下载地址
     */
    public String getKey() {
        if (transferType == TransferType.UPLOAD) {
            return getPath();
        } else {
            return getUrl();
        }
    }
}