Package org.knime.core.ui.component

Class CheckForComponentUpdatesUtil

java.lang.Object

org.knime.core.ui.component.CheckForComponentUpdatesUtil

public final class CheckForComponentUpdatesUtil
extends Object

Helper to identify components that needs an update.

Author:

Leon Wenzler, KNIME AG, Konstanz, Germany, Martin Horn, KNIME GmbH, Konstanz, Germany

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CheckForComponentUpdatesUtil.ComponentUpdatesResult

Method Summary

Modifier and Type	Method	Description
static CheckForComponentUpdatesUtil.ComponentUpdatesResult	checkForComponentUpdatesAndSetUpdateStatus(org.knime.core.node.workflow.WorkflowManager hostWFM, String pluginId, List<org.knime.core.node.workflow.NodeID> candidateList, org.eclipse.core.runtime.IProgressMonitor monitor)	Checks whether and which components require an update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

checkForComponentUpdatesAndSetUpdateStatus

public static CheckForComponentUpdatesUtil.ComponentUpdatesResult checkForComponentUpdatesAndSetUpdateStatus(org.knime.core.node.workflow.WorkflowManager hostWFM,
 String pluginId,
 List<org.knime.core.node.workflow.NodeID> candidateList,
 org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                      throws InterruptedException,
IllegalStateException

Checks whether and which components require an update. It also changes the update-status of the components (i.e. MetaNodeTemplateInformation.getUpdateStatus()).

Parameters:

hostWFM -

pluginId - the unique identifier of the relevant plug-in; passed to the Status-object encapsulated in the returned CheckForComponentUpdatesUtil.ComponentUpdatesResult

candidateList -

monitor -

Returns:

the component update result

Throws:

InterruptedException

IllegalStateException