/*
 * Copyright (c) 2010-2025 Contributors to the openHAB project
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.openhab.core.io.transport.modbus.exception;

import java.io.Serial;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.io.transport.modbus.endpoint.ModbusSlaveEndpoint;

/**
 * Exception for connection issues
 *
 * @author Sami Salonen - Initial contribution
 *
 */
@NonNullByDefault
public class ModbusConnectionException extends ModbusTransportException {

    @Serial
    private static final long serialVersionUID = -6171226761518661925L;
    private ModbusSlaveEndpoint endpoint;

    /**
     *
     * @param endpoint endpoint associated with this exception
     */
    public ModbusConnectionException(ModbusSlaveEndpoint endpoint) {
        this.endpoint = endpoint;
    }

    /**
     * Get endpoint associated with this connection error
     *
     * @return endpoint with the error
     */
    public ModbusSlaveEndpoint getEndpoint() {
        return endpoint;
    }

    @Override
    public @Nullable String getMessage() {
        return String.format("Error connecting to endpoint %s", endpoint);
    }

    @Override
    public String toString() {
        return String.format("ModbusConnectionException(Error connecting to endpoint=%s)", endpoint);
    }
}
