V2NIMMessageLocationAttachmentBuilder.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageLocationAttachment;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageLocationAttachmentImpl;

/**
 * V2NIM消息位置附件构建器
 * <p>
 * 该类用于构建V2NIM消息中的位置附件。它遵循构建器模式，允许链式调用来设置位置信息。
 */
public final class V2NIMMessageLocationAttachmentBuilder {

    /**
     * 纬度
     */
    private double latitude;
    /**
     * 经度
     */
    private double longitude;
    /**
     * 详细位置信息
     */
    private String address;

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

    /**
     * 设置纬度，范围在-90到90之间，超出范围的无效
     *
     * @param latitude 纬度值
     * @return 当前构建器实例
     */
    public V2NIMMessageLocationAttachmentBuilder withLatitude(double latitude) {
        // 纬度不在有效范围内，无效
        if (latitude < -90 || latitude > 90) {
            return this;
        }
        this.latitude = latitude;
        return this;
    }

    /**
     * 设置经度，范围在-180到180之间，超出范围的无效
     *
     * @param longitude 经度值
     * @return 当前构建器实例
     */
    public V2NIMMessageLocationAttachmentBuilder withLongitude(double longitude) {
        // 经度不在有效范围内，无效
        if (longitude < -180 || longitude > 180) {
            return this;
        }
        this.longitude = longitude;
        return this;
    }

    /**
     * 设置详细地址
     *
     * @param address 地址字符串
     * @return 当前构建器实例
     */
    public V2NIMMessageLocationAttachmentBuilder withAddress(String address) {
        this.address = address;
        return this;
    }

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

    /**
     * 构建V2NIMMessageLocationAttachment实例
     *
     * @return 新的V2NIMMessageLocationAttachment实例
     */
    public V2NIMMessageLocationAttachment build() {
        return new V2NIMMessageLocationAttachmentImpl(latitude, longitude, address);
    }
}