V2NIMMessageImageAttachmentBuilder.java

浏览该文件的文档.

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

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

/**
 * V2NIMMessageImageAttachmentBuilder类
 *
 * 用于构建图片消息附件的构建器类。
 * 此类使用建造者模式，允许链式调用设置各种属性。
 */
public final class V2NIMMessageImageAttachmentBuilder {

    /**
     * 文件路径
     */
    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 int    width;
    /**
     * 图片高度
     */
    private int    height;

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

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

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

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

    /**
     * 设置文件大小，如果小于0，则不设置
     *
     * @param size 文件大小
     * @return 当前构建器实例
     */
    public V2NIMMessageImageAttachmentBuilder 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 V2NIMMessageImageAttachmentBuilder withSceneName(String sceneName) {
        this.sceneName = sceneName;
        return this;
    }

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

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

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

    /**
     * 设置图片宽度，如果小于0，则不设置
     *
     * @param width 图片宽度
     * @return 当前构建器实例
     */
    public V2NIMMessageImageAttachmentBuilder withWidth(int width) {
        if (width >= 0) {
            this.width = width;
        }
        return this;
    }

    /**
     * 设置图片高度，如果小于0，则不设置
     *
     * @param height 图片高度
     * @return 当前构建器实例
     */
    public V2NIMMessageImageAttachmentBuilder withHeight(int height) {
        if (height >= 0) {
            this.height = height;
        }
        return this;
    }

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