V2NIMMessageFileAttachmentBuilder.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.attachment.builder;

import com.netease.nimlib.sdk.v2.storage.V2NIMStorageSceneConfig;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageFileAttachmentImpl;

/**
 * V2NIMMessageFileAttachmentBuilder 类
 *
 * 这个类用于构建文件附件消息。它使用了构建器模式，允许用户通过链式调用设置各种属性。
 */
public final class V2NIMMessageFileAttachmentBuilder {

    /**
     * 文件路径
     */
    private String path;
    /**
     * 文件显示名称
     */
    private String name;
    /**
     * 文件大小
     */
    private long   size;
    /**
     * 文件存储场景名
     * 默认为{@link com.netease.nimlib.sdk.v2.storage.V2NIMStorageSceneConfig#DEFAULT_IM}的getSceneName()值
     */
    private String sceneName = V2NIMStorageSceneConfig.DEFAULT_IM.getSceneName();
    /**
     * 文件MD5
     */
    private String md5;
    /**
     * 文件上传服务器路径
     */
    private String url;
    /**
     * 文件后缀名
     */
    private String ext;

    /**
     * 私有构造函数，防止直接实例化
     */
    private V2NIMMessageFileAttachmentBuilder() {
    }

    /**
     * 创建一个新的V2NIMMessageFileAttachmentBuilder实例
     *
     * @return 新的V2NIMMessageFileAttachmentBuilder实例
     */
    public static V2NIMMessageFileAttachmentBuilder builder() {
        return new V2NIMMessageFileAttachmentBuilder();
    }

    /**
     * 设置文件路径
     *
     * @param path 文件路径
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withPath(String path) {
        this.path = path;
        return this;
    }

    /**
     * 设置文件名称
     *
     * @param name 文件名称
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withName(String name) {
        this.name = name;
        return this;
    }

    /**
     * 设置文件大小，如果小于0，则不设置
     *
     * @param size 文件大小（字节）
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withSize(long size) {
        if (size >= 0) {
            this.size = size;
        }
        return this;
    }

    /**
     * 设置文件存储场景名，默认为{@link com.netease.nimlib.sdk.v2.storage.V2NIMStorageSceneConfig#DEFAULT_IM}的getSceneName()值
     * @param sceneName 存储场景名
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withSceneName(String sceneName) {
        this.sceneName = sceneName;
        return this;
    }

    /**
     * 设置文件MD5
     *
     * @param md5 文件MD5值
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withMd5(String md5) {
        this.md5 = md5;
        return this;
    }

    /**
     * 设置文件URL
     *
     * @param url 文件上传服务器路径
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withUrl(String url) {
        this.url = url;
        return this;
    }

    /**
     * 设置文件扩展名
     *
     * @param ext 文件扩展名
     * @return 当前构建器实例
     */
    public V2NIMMessageFileAttachmentBuilder withExt(String ext) {
        this.ext = ext;
        return this;
    }

    /**
     * 构建V2NIMMessageFileAttachmentImpl实例
     *
     * @return 新的V2NIMMessageFileAttachmentImpl实例
     */
    public V2NIMMessageFileAttachmentImpl build() {
        return new V2NIMMessageFileAttachmentImpl(path, size, md5, url, ext, name, sceneName, null);
    }
}