ZWaveCommandClassValueEvent.java

/**
 * Copyright (c) 2010-2016 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.openhab.binding.zwave.internal.protocol.event;

import org.openhab.binding.zwave.internal.protocol.commandclass.ZWaveCommandClass.CommandClass;

/**
 * ZWave Command Class event. This event is fired when a command class
 * receives a value from the node. The event can be subclasses to add
 * additional information to the event.
 *
 * @author Jan-Willem Spuij
 * @since 1.4.0
 */
public class ZWaveCommandClassValueEvent extends ZWaveEvent {

    private final CommandClass commandClass;
    private final Object value;

    /**
     * Constructor. Creates a new instance of the ZWaveCommandClassValueEvent class.
     *
     * @param nodeId the nodeId of the event
     * @param endpoint the endpoint of the event.
     * @param commandClass the command class that fired the ZWaveCommandClassValueEvent;
     * @param value the value for the event.
     */
    public ZWaveCommandClassValueEvent(int nodeId, int endpoint, CommandClass commandClass, Object value) {
        super(nodeId, endpoint);

        this.commandClass = commandClass;
        this.value = value;
    }

    /**
     * Gets the command class that fired the ZWaveCommandClassValueEvent;
     *
     * @return the command class.
     */
    public CommandClass getCommandClass() {
        return commandClass;
    }

    /**
     * Gets the value for the event.
     *
     * @return the value.
     */
    public Object getValue() {
        return value;
    }
}