org.bidib.wizard.api.script.Scripting Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bidibwizard-api Show documentation

jBiDiB BiDiB Wizard API POM

The newest version!

package org.bidib.wizard.api.script;

import java.util.Collections;
import java.util.List;

import org.bidib.wizard.api.model.NodeInterface;

public interface Scripting {

    static final String KEY_SCRIPT_ERRORS = "scriptErrors";

    static final String KEY_OPTIONS = "options";

    static final String OPTION_DISCONNECT_ON_ERROR = "disconnectOnError";

    /**
     * Get all nodes that match the provided VID and PID.
     * 
     * @param vid
     *            the vendor id
     * @param pid
     *            the product id
     * @return the nodes that match
     */
    default List getNodesByVidAndPid(int vid, int pid) {
        return Collections.emptyList();
    }

    /**
     * Get all nodes.
     * 
     * @return the nodes
     */
    default List getAllNodes() {
        return Collections.emptyList();
    }

    /**
     * Show echo message in log window.
     * 
     * @param echoMessage
     *            the echo message
     */
    default void echo(String echoMessage) {
    }
}