Package com.illumon.iris.console.events

Class UIConnectors

java.lang.Object

com.illumon.iris.console.events.UIConnectors

public abstract class UIConnectors
extends Object

A class providing a framework for user interface managers to interact with the Deephaven Console. Define any UIConnectors in configuration: ui.connector.class.[name]=[fully-qualified class name]

Field Summary

Fields

Modifier and Type	Field	Description
static String	UI_CONNECTOR_CLASS

Constructor Summary

Constructors

Constructor	Description
UIConnectors()

Method Summary

Modifier and Type	Method	Description
static IUIConnector	getUIConnectorByName(String name)	Get a specific UI connector by name, if one exists by that name.
static Collection<IUIConnector>	getUIConnectors()	Get all of the UI connectors at once.

Methods inherited from class java.lang.Object

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

Field Details

UI_CONNECTOR_CLASS

public static final String UI_CONNECTOR_CLASS

See Also:

Constant Field Values

Constructor Details

UIConnectors

public UIConnectors()

Method Details

getUIConnectors

@ScriptApi public static Collection<IUIConnector> getUIConnectors()

Get all of the UI connectors at once.

Returns:

An unmodifiable collection of all the UI connectors.

getUIConnectorByName

@ScriptApi public static IUIConnector getUIConnectorByName(String name)

Get a specific UI connector by name, if one exists by that name.

Parameters:

name - The name of the UI connector to return

Returns:

The UI connector configured with the specified name, or null if no such connector exists.