ZWaveTransactionCompletedEvent.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.SerialMessage;

/**
 * ZWave Transaction Completed Event. Indicated that a transaction (a
 * sequence of messages with an expected reply) has completed.
 *
 * @author Jan-Willem Spuij
 * @since 1.4.0
 */
public class ZWaveTransactionCompletedEvent extends ZWaveEvent {

    private final SerialMessage completedMessage;
    private final boolean state;

    /**
     * Constructor. Creates a new instance of the ZWaveTransactionCompletedEvent
     * class.
     * The 'state' flag is provided by the message handler when the message is processed
     * and its value is defined by the message class.
     *
     * @param completedMessage the original {@link SerialMessage} that has been completed.
     * @param state a flag indicating success / failure of the transaction processing
     */
    public ZWaveTransactionCompletedEvent(SerialMessage completedMessage, boolean state) {
        super(completedMessage.getMessageNode());

        this.completedMessage = completedMessage;
        this.state = state;
    }

    /**
     * Gets the original {@link SerialMessage} that has been completed.
     *
     * @return the original message.
     */
    public SerialMessage getCompletedMessage() {
        return completedMessage;
    }

    /**
     * Returns the processing state of this transaction
     *
     * @return
     */
    public boolean getState() {
        return state;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("ZWaveTransactionCompletedEvent [completedMessage=").append(completedMessage).append(", state=")
                .append(state).append("]");
        return builder.toString();
    }
}