org.instantreality.InstantIO
Class Root

java.lang.Object
  org.instantreality.InstantIO.Namespace
      org.instantreality.InstantIO.Root

public final class Root
extends Namespace

The root namespace. InSlots and OutSlots have to be added to Namespaces to connect them to each other. But there is one major problem: How do two software components that do not know anything about each other add their InSlots and OutSlots to the same Namespace?

The Root class is the answer to this question. It serves as a root namespace for all namespaces used by the system. Root is a singleton, i.e. there exists exactly one instance of the Root class. Therefore, it is not possible to create new instances of the Root class (the constructor is private). Instead, software components that need to access the single instance have to call the static method the, as demonstrated in the following example:

 Namespace root = Root.the();
 

Author:

Patrick Dähne

See Also:

Namespace

Nested Class Summary

Nested classes/interfaces inherited from class org.instantreality.InstantIO.Namespace

Namespace.Listener

Method Summary

static Root

the() Returns the single instance of the Root class.

Methods inherited from class org.instantreality.InstantIO.Namespace

addExternalRoute, addInSlot, addListener, addNamespace, addNamespace, addOutSlot, addRoute, clear, clearExternalRoutes, clearNamespaces, clearRoutes, dirty, disable, dispose, enable, enabled, finalize, getBaseURL, getFieldNames, getFieldValue, getLabel, initialize, removeExternalRoute, removeInSlot, removeListener, removeNamespace, removeOutSlot, removeRoute, saveState, setBaseURL, setDirty, setFieldValue, setFieldValues, shutdown, typeName

Methods inherited from class java.lang.Object

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

Method Detail

the

public static Root the()

Returns the single instance of the Root class.

The following example demonstrates how to get a reference to the single root instance by calling this method:

 Namespace root = Root.the();
 

Returns:

The single instance.