[openhab-addons.git] /

/**
 * Copyright (c) 2010-2024 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.binding.insteon.internal.transport.message;

import java.util.Arrays;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.insteon.internal.device.InsteonAddress;
import org.openhab.binding.insteon.internal.utils.HexUtils;

/**
 * An Insteon message has several fields with known type and offset
 * within the message. This class represents a single field, and
 * holds name, type, and offset (but not value!).
 *
 * @author Daniel Pfrommer - Initial contribution
 * @author Rob Nielsen - Port to openHAB 2 insteon binding
 * @author Jeremy Setton - Rewrite insteon binding
 */
@NonNullByDefault
public final class Field {
    private final String name;
    private final int offset;
    private final DataType type;

    public String getName() {
        return name;
    }

    public int getOffset() {
        return offset;
    }

    public DataType getType() {
        return type;
    }

    public Field(String name, DataType type, int offset) {
        this.name = name;
        this.type = type;
        this.offset = offset;
    }

    private void check(int len, DataType t) throws FieldException {
        if (offset + type.getSize() > len) {
            throw new FieldException("field write beyond end of msg");
        }
        if (type != t) {
            throw new FieldException("field write type mismatch!");
        }
    }

    public void set(byte[] data, Object o) throws FieldException {
        switch (type) {
            case BYTE:
                setByte(data, (Byte) o);
                break;
            case ADDRESS:
                setAddress(data, (InsteonAddress) o);
                break;
            default:
                throw new FieldException("field data type unknown");
        }
    }

    /**
     * Sets a byte value to a byte array, at the proper offset.
     * Use this function to set the value of a field within a message.
     *
     * @param data the byte array to update
     * @param b the byte value to set
     * @throws FieldException
     */
    public void setByte(byte[] data, byte b) throws FieldException {
        check(data.length, DataType.BYTE);
        data[offset] = b;
    }

    /**
     * Sets the value of an InsteonAddress to a message array.
     * Use this function to set the value of a field within a message.
     *
     * @param data the byte array to update
     * @param address the insteon address value to set
     * @throws FieldException
     */
    public void setAddress(byte[] data, InsteonAddress address) throws FieldException {
        check(data.length, DataType.ADDRESS);
        System.arraycopy(address.getBytes(), 0, data, offset, type.getSize());
    }

    /**
     * Returns a byte from a byte array at the field position
     *
     * @param data the byte array to use
     * @return the byte
     * @throws FieldException
     */
    public byte getByte(byte[] data) throws FieldException {
        check(data.length, DataType.BYTE);
        return data[offset];
    }

    /**
     * Returns an insteon address from the field position
     *
     * @param data the byte array to use
     * @return the insteon address
     * @throws FieldException
     */
    public InsteonAddress getAddress(byte[] data) throws FieldException {
        check(data.length, DataType.ADDRESS);
        byte[] address = Arrays.copyOfRange(data, offset, offset + type.getSize());
        return new InsteonAddress(address);
    }

    /**
     * Returns a string representation for a given byte array
     *
     * @param data the byte array to use
     * @return the string representation
     */
    public String toString(byte[] data) {
        String s = name + ":";
        try {
            switch (type) {
                case BYTE:
                    s += HexUtils.getHexString(getByte(data));
                    break;
                case ADDRESS:
                    s += getAddress(data).toString();
                    break;
                default:
                    throw new FieldException("field data type unknown");
            }
        } catch (FieldException e) {
            s += "NULL";
        }
        return s;
    }

    @Override
    public String toString() {
        return name + " Type: " + type + " Offset: " + offset;
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (obj == this) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Field other = (Field) obj;
        return name.equals(other.name) && offset == other.offset;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + name.hashCode();
        result = prime * result + offset;
        return result;
    }
}