ZWaveNodeInitStage.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.initialization;

import java.util.HashMap;
import java.util.Map;

/**
 * Node Stage Enumeration for node initialisation.
 *
 * @author Brian Crosby
 * @author Chris Jackson
 * @since 1.3.0
 */
public enum ZWaveNodeInitStage {
    EMPTYNODE(0, true, "Empty New Node"),
    PROTOINFO(1, true, "Protocol Information"),
    NEIGHBORS(2, true, "Node Neighbor Information"),
    FAILED_CHECK(3, true, "Checking if node is failed"),
    WAIT(4, true, "Waiting"),
    PING(5, true, "Ping Node"),
    SECURITY_REPORT(6, true, "Security Report"),
    DETAILS(7, true, "Node Information"),
    MANUFACTURER(8, true, "Manufacture Name and Product Identification"),
    VERSION(9, true, "Command Class Versions"),
    APP_VERSION(10, true, "Application Version"),
    ENDPOINTS(11, true, "Command Class Endpoints"),
    UPDATE_DATABASE(12, true, "Updating database"),
    STATIC_VALUES(13, true, "Static Information"),
    ASSOCIATIONS(14, false, "Associations"),
    SET_WAKEUP(15, false, "Wakeup Target"),
    SET_ASSOCIATION(16, false, "Wakeup Target"),
    GET_CONFIGURATION(17, false, "Getting configuration"),
    STATIC_END(18, false, "Static Initialisation Finished"),

    // States below are not restored from the configuration files
    SESSION_START(19, false, "Restore Marker"),
    DYNAMIC_VALUES(20, false, "Frequently Changed Information"),

    DONE(21, false, "Node Complete");

    private int stage;
    private boolean mandatory;
    private String label;

    /**
     * A mapping between the integer code and its corresponding
     * Node Stage to facilitate lookup by code.
     */
    private static Map<Integer, ZWaveNodeInitStage> codeToNodeStageMapping;

    private ZWaveNodeInitStage(int s, boolean m, String l) {
        stage = s;
        mandatory = m;
        label = l;
    }

    private static void initMapping() {
        codeToNodeStageMapping = new HashMap<Integer, ZWaveNodeInitStage>();
        for (ZWaveNodeInitStage s : values()) {
            codeToNodeStageMapping.put(s.stage, s);
        }
    }

    /**
     * Get the stage protocol number.
     *
     * @return number
     */
    public int getStage() {
        return this.stage;
    }

    /**
     * Get the stage label
     *
     * @return label
     */
    public String getLabel() {
        return this.label;
    }

    /**
     * Lookup function based on the command class code.
     * Returns null if there is no command class with code i
     *
     * @param i the code to lookup
     * @return enumeration value of the command class.
     */
    public static ZWaveNodeInitStage getNodeStage(int i) {
        if (codeToNodeStageMapping == null) {
            initMapping();
        }

        return codeToNodeStageMapping.get(i);
    }

    /**
     * Return the next stage after the current stage
     *
     * @return the next stage
     */
    public ZWaveNodeInitStage getNextStage() {
        for (ZWaveNodeInitStage s : values()) {
            if (s.stage == this.stage + 1) {
                return s;
            }
        }

        return null;
    }

    /**
     * Check if the current stage has completed the static stages.
     *
     * @return true if static stages complete
     */
    public boolean isStaticComplete() {
        if (stage > SESSION_START.stage) {
            return true;
        }
        return false;
    }

    /**
     * Check if the current stage has completed the static stages.
     *
     * @return true if static stages complete
     */
    public boolean isStageMandatory() {
        return mandatory;
    }
}