FirmwareUID.java

/**
 * Copyright (c) 2014-2017 by the respective copyright holders.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.eclipse.smarthome.core.thing.binding.firmware;

import org.eclipse.smarthome.core.thing.ThingTypeUID;

import com.google.common.base.Preconditions;

/**
 * The {@link FirmwareUID} is the unique identifier for a {@link Firmware}. It consists of the {@link ThingTypeUID} and
 * the corresponding firmware version.
 *
 * @author Thomas Höfer - Initial contribution
 */
public final class FirmwareUID {

    private ThingTypeUID thingTypeUID;
    private String firmwareVersion;

    /**
     * Default constructor. Will allow to instantiate this class by reflection.
     */
    protected FirmwareUID() {
        // does nothing at all
    }

    /**
     * Creates a new firmware UID.
     *
     * @param thingTypeUID the thing type UID (must not be null)
     * @param firmwareVersion the version of the firmware (must not be null)
     *
     * @throws NullPointerException if given thing type UID or firmware version is null
     * @throws IllegalArgumentException if given firmware version is null or empty or consist of a colon
     */
    public FirmwareUID(ThingTypeUID thingTypeUID, String firmwareVersion) {
        Preconditions.checkNotNull(thingTypeUID, "Thing type UID must not be null.");
        Preconditions.checkArgument(firmwareVersion != null && !firmwareVersion.isEmpty(),
                "Firmware version must not be null or empty.");
        Preconditions.checkArgument(!firmwareVersion.contains(":"), "Firmware version must not consist of a colon.");
        this.thingTypeUID = thingTypeUID;
        this.firmwareVersion = firmwareVersion;
    }

    /**
     * Returns the thing type UID.
     *
     * @return the thing type UID
     */
    public ThingTypeUID getThingTypeUID() {
        return thingTypeUID;
    }

    /**
     * Returns the firmware version.
     *
     * @return the firmware version
     */
    public String getFirmwareVersion() {
        return firmwareVersion;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((firmwareVersion == null) ? 0 : firmwareVersion.hashCode());
        result = prime * result + ((thingTypeUID == null) ? 0 : thingTypeUID.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        FirmwareUID other = (FirmwareUID) obj;
        if (firmwareVersion == null) {
            if (other.firmwareVersion != null) {
                return false;
            }
        } else if (!firmwareVersion.equals(other.firmwareVersion)) {
            return false;
        }
        if (thingTypeUID == null) {
            if (other.thingTypeUID != null) {
                return false;
            }
        } else if (!thingTypeUID.equals(other.thingTypeUID)) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "FirmwareUID [thingTypeUID=" + thingTypeUID + ", firmwareVersion=" + firmwareVersion + "]";
    }

}