Class VirtualSpace

    • Field Detail

      • MAP_CLASS_PROP_NAME

        public static final java.lang.String MAP_CLASS_PROP_NAME
        The focus mapper class property name: "mapClass".
        See Also:
        Constant Field Values
    • Constructor Detail

      • VirtualSpace

        public VirtualSpace()
        Creates the VirtualSpace property container without a name. The name must be set in all cases using the setPropertyAtom call.
      • VirtualSpace

        public VirtualSpace​(Atom propertyAtom)
        Creates the VirtualSpace property container with the specified name. All system-reserved names for components begins with "$".
        Parameters:
        propertyAtom - the name of the component, unique within it's parent.
    • Method Detail

      • getVSReference

        public VSReference getVSReference​(Atom refAtom)
        Gets the VSReference to this VirtualSpace.
        Specified by:
        getVSReference in interface IGProp<GProp<?>[]>
        Overrides:
        getVSReference in class PropCnr
        Parameters:
        refAtom - The reference atom (unused).
        Returns:
        A fake VSReference that references this VirtualSpace instance.
      • createVSReference

        public VSReference createVSReference​(Atom refAtom,
                                             PropCnr[] returnParent)
        Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

        This method needs to be overridden by subclasses of PropCnr that has a VSReference as property, and *SHOULD* match getVSReference(Atom).

        The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, null is returned.

        Overrides:
        createVSReference in class PropCnr
        Parameters:
        refAtom - The property asking for the VSReference.
        returnParent - An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.
        Returns:
        The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.

        For this method, it's always null!

      • createVSParticipantsHolder

        protected VSParticipantsHolder createVSParticipantsHolder()
        Creates a new instance of the VSParticipantsHolder.
      • addPredefinedProps

        protected void addPredefinedProps()
                                   throws PropException
        Adds the predefined properties for this container. This method is called once just after construction of the property container and sometimes population of it.

        The method should add properties to create or get reference to using the maybeAddProp method. When the PropCnr instance is cloned, the method getPredefinedProps() is called in order for the subclass to be able to retrieve the new instances to these properties, if stored in instance variables.

        Overrides:
        addPredefinedProps in class PropCnr
        Throws:
        PropException - for property exceptions.
      • getPredefinedProps

        protected void getPredefinedProps()
        Gets potential references to predefined properties for this container. This method is called once just after cloning of the property container.

        The method should get reference to using the getProp(...) methods. This allows the subclass to be able to retrieve the new instances to the properties created during addPredefinedProps() if stored in instance variables.

        Overrides:
        getPredefinedProps in class PropCnr
      • isFree

        public boolean isFree​(java.lang.Runnable callback,
                              boolean callbackIfFree,
                              VSComponent component)
        Verifies if the component is included in a work unit currently in progress in this VirtualSpace.
        Parameters:
        callback - The callback to call when work completes, or null for none.
        callbackIfFree - Performs a call to the callback if free when true.
        component - The component to verify.
        Returns:
        true if it's OK to process, false means the component is included in this work unit and if callback is non-null, it will be called. The callback is called if free and the flag callbackIfFree is true.
      • areFree

        public boolean areFree​(java.lang.Runnable callback,
                               boolean callbackIfFree,
                               VSComponent... components)
        Verifies if the component(s) is/are included in a work unit currently in progress in this VirtualSpace.
        Parameters:
        callback - The callback to call when work completes, or null for none.
        callbackIfFree - Performs a call to the callback if free when true.
        components - The components to verify.
        Returns:
        true if it's OK to process, false means the component is included in this work unit and if callback is non-null, it will be called. The callback is called if free and the flag callbackIfFree is true.
      • areFree2

        public boolean areFree2​(java.lang.Runnable callback,
                                boolean callbackIfFree,
                                VSComponent component,
                                VSComponent... components)
        Verifies if the components are included in a work unit currently in progress in this VirtualSpace.
        Parameters:
        callback - The callback to call when work completes, or null for none.
        callbackIfFree - Performs a call to the callback if free when true.
        component - A component to verify.
        components - The components to verify.
        Returns:
        true if it's OK to process, false means the component is included in this work unit and if callback is non-null, it will be called. The callback is called if free and the flag callbackIfFree is true.
      • onEventSelf

        public void onEventSelf​(GEvent event)
        Checks for state change events and fires it to listeners.
        Specified by:
        onEventSelf in interface IGProp<GProp<?>[]>
        Overrides:
        onEventSelf in class GProp<GProp<?>[]>
        Parameters:
        event - The property event.
      • onParentStateChanged

        public void onParentStateChanged​(IVSComponent parent,
                                         IVSComponentState.State state,
                                         boolean on)
        Called when the column changes state.
        Specified by:
        onParentStateChanged in interface IVSComponentListener
        Parameters:
        parent - The parent who's state was changed.
        state - The state change, possible values PARENT_ENABLED, PARENT_READONLY, PARENT_VISIBLE.
        on - New state.
      • canRequestFocus

        public java.lang.String canRequestFocus()
        Returns if this component can receive focus. Focus capable components may override to return null for success, or other error message.

        Default processing is to return "Component not focusable" if the component doesn't implement the IFocusComp interface, "Not virtualized" if the component is not in a virtualized state, "Component is hidden" if IVSComponent.isVisible() is false or "Component is disabled" if IVSComponent.isEnabled() is false.

        Specified by:
        canRequestFocus in interface IPropCnr
        Returns:
        null focus is possible to this component, or an error message describing why focus cannot be requested.
      • couldRequestFocusIfVirtualized

        public java.lang.String couldRequestFocusIfVirtualized​(boolean ignoreStates)
        Returns if this component could receive focus if it would be virtualized. Focus capable components may override to return null for success, or other error message.

        Default processing is to return "Component not focusable" if the component doesn't implement the IFocusComp interface, "Component is hidden" if IVSComponent.isVisible() is false or "Component is disabled" if IVSComponent.isEnabled() is false.

        Specified by:
        couldRequestFocusIfVirtualized in interface IPropCnr
        Parameters:
        ignoreStates - Flag indicating that states should be ignored, such as visible or enabled. If false, hidden or disabled components return an error message.
        Returns:
        null focus is possible to this component, or an error message describing why focus cannot be requested.
      • onFocusGained

        public void onFocusGained​(IFocusComp opposite,
                                  IGProp<?> trigger,
                                  boolean isRemoteInduced)
        Called to the component when it receives focus.

        Focus components override this method if they need to process focus lost.

        Specified by:
        onFocusGained in interface IFocusComp
        Parameters:
        opposite - Component losing focus, null for none.
        trigger - The trigger property, null for none.
        isRemoteInduced - Flag indicating this event is due to a remote event.
      • onFocusLost

        public void onFocusLost​(IFocusComp focusComp,
                                IGProp<?> trigger,
                                boolean isRemoteInduced)
        Called to the focused component when it loses focus.

        Focus components override this method if they need to process focus lost.

        Specified by:
        onFocusLost in interface IFocusComp
        Parameters:
        focusComp - Component receiving focus, null for none.
        trigger - The trigger property, null for none.
        isRemoteInduced - Flag indicating this event is due to a remote event.
      • onRemoteEvent

        public void onRemoteEvent​(RemoteEvent event)
        Called when a remote property event should be processed by this property.

        A subclass can override this method to perform appropriate processing and is not required to call super.onRemoteEvent(e).

        The onRemoteEvent is NOT called when in a proxied property container, but rather the normal onEventSelf method.

        Specified by:
        onRemoteEvent in interface IGProp<GProp<?>[]>
        Overrides:
        onRemoteEvent in class GProp<GProp<?>[]>
        Parameters:
        event - The remote event.
      • forbiddenGetCustomDataMap

        @Deprecated
        public java.util.Map<java.lang.String,​java.lang.Object> forbiddenGetCustomDataMap​(boolean doCreate)
        Deprecated.
        Gets or creates the provider map. This method is not intended to be called by user code, it is used by the system.

        Do not call this method!

        Specified by:
        forbiddenGetCustomDataMap in interface ICustomDataProvider
        Parameters:
        doCreate - Creates the map if required.
        Returns:
        The map or newly created map, null if not created.

        Note: the map returned is NOT synchronized thus not thread safe. It is up to the caller to synchronize on it to ensure thread safety.

      • virtualize

        public VirtualSpace virtualize​(IAppSessionGyro appGyro)
        Call this method to "virtualize" a property tree. This method is used at runtime in the Server for the application session of virtual instances of v, but also virtual instances of panels, for the individual client session. The v is virtualized once for the application session and is shared for parallel client sessions.

        This method is similar to cloning, but enables references that are already resolved to remain if they point to a shared instance, e.g. the v pointing to its participants in the application property container shared instance, or a panel with references to text IDs, assets, etc.

        It is up to the property class to handle this by overriding this method.

        Parameters:
        appGyro - The application gyro instance performing the virtualization.
        Throws:
        java.lang.NullPointerException - If appGyro is null.
      • doVirtualizePropCnr

        protected void doVirtualizePropCnr​(IAppSessionGyro appGyro,
                                           IClientSessionGyro clientGyro,
                                           GProp<?>[] props,
                                           java.lang.String extendsName,
                                           VirtualSpace virtualSpace,
                                           PropCnr virtualizedProp,
                                           PropCnr clonedProp)
                                    throws java.lang.CloneNotSupportedException,
                                           PropException
        The rest of the virtualization is done using the correct "this" for inner classes.

        Do not call this method! The method is intended for classes that are virtualized and needs to set-up the AppSessionGyro, ClientSessionGyro and v very early in the virtualizing process.

        Overrides:
        doVirtualizePropCnr in class PropCnr
        Parameters:
        appGyro - The application gyro instance performing the virtualization.
        clientGyro - The client gyro session, can be null if not initialized from the client gyro.
        props - The children properties to virtualize.
        extendsName - The name in extends to virtualize.
        virtualSpace - The virtualized or virtualizing v.
        virtualizedProp - The property being virtualized.
        clonedProp - The property that is cloned to produce this virtualized property.
        Throws:
        java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
        PropException - For property errors during the virtualization.
      • virtualize

        protected GProp<?> virtualize​(IAppSessionGyro appGyro,
                                      IClientSessionGyro clientGyro,
                                      VirtualSpace virtualSpace,
                                      PropCnr virtualizedProp)
                               throws java.lang.CloneNotSupportedException,
                                      PropException
        Call this method to "virtualize" a property tree. This method is used at runtime in the Server for the application session of virtual instances of VirtualSpace, but also virtual instances of panels, for the individual client session. The VirtualSpace is virtualized once for the application session and is shared for parallel client sessions.

        This method is similar to cloning, but enables references that are already resolved to remain if they point to a shared instance, e.g. the VirtualSpace pointing to its participants in the application property container shared instance, or a panel with references to text IDs, assets, etc.

        It is up to the property class to handle this by overriding this method.

        Overrides:
        virtualize in class PropCnr
        Parameters:
        appGyro - The application gyro instance performing the virtualization.
        clientGyro - The client gyro session, can be null if not initialized from the client gyro.
        virtualSpace - The virtualized VirtualSpace.
        virtualizedProp - The property being virtualized.
        Returns:
        The virtualized property.
        Throws:
        java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
        PropException - For property errors during the virtualization.
      • getNonVirtualized

        public VirtualSpace getNonVirtualized()
        Gets the non-virtualized instance of this component, i.e. a VirtualSpace.
        Specified by:
        getNonVirtualized in interface IVSComponent
        Returns:
        The non-virtualized VirtualSpace, always non-null.
      • getVirtualized

        public VirtualSpace getVirtualized()
        Gets the virtualized instance of this component, i.e. a VirtualSpace.

        If this VirtualSpace already is virtualized, the same instance is returned.

        If the VirtualSpace in the application session is not virtualized, this method returns null. Use the method getVirtualized(boolean) with true as parameter to also perform the virtualization.

        This method can return null, but not when called from an application session context, i.e. any kind of threads running in the server for an application. This means that you should not require to test for null in the code.

        Returns:
        The virtualized VirtualSpace, null if Application Session Gyro cannot be found for current thread.
      • getVirtualized

        public VirtualSpace getVirtualized​(boolean doVirtualize)
        Gets the virtualized instance of this component, i.e. a VirtualSpace.

        If this VirtualSpace already is virtualized, the same instance is returned.

        This method can return null, but not when called from an application session context, i.e. any kind of threads running in the server for an application. This means that you should not require to test for null in the code.

        Parameters:
        doVirtualize - Flag to virtualize the VirtualSpace if not yet virtualized in the application session.
        Returns:
        The virtualized VirtualSpace, null if Application Session Gyro cannot be found for current thread.
      • getAppSessionGyro

        public IAppSessionGyro getAppSessionGyro()
        Returns the Application Session Gyro instance of this virtualized property.

        NOTE: Use the code IAppSessionGyro.getSessionInstance() to get the application session gyro derived from the current thread (and thread group). This will work for all threads in an application session environment in the server.

        Specified by:
        getAppSessionGyro in interface IGProp<GProp<?>[]>
        Overrides:
        getAppSessionGyro in class GProp<GProp<?>[]>
        Returns:
        The Application Session Gyro if this instance is virtualized, null otherwise.
      • onPanelVirualized

        public boolean onPanelVirualized​(UIPanelBase panel)
        Called when a panel has been virtualized. Do no call this method, it is intended for the framework.
        Parameters:
        panel - The panel virtualized.
        Returns:
        Success flag.
      • onPanelDestroyed

        public boolean onPanelDestroyed​(UIPanelBase panel)
        Called when a panel is destroyed after being virtualized and attached to the VirtualSpace.
        Parameters:
        panel - The panel virtualized being destroyed.
        Returns:
        Success flag.
      • getAttachedVirtualizedPanels

        public UIPanelBase[] getAttachedVirtualizedPanels()
        Gets the attached panels of this current instance of the VirtualSpace.
        Returns:
        The array of panels for all client sessions connected to this VirtualSpace of the same user and app session.
      • getVirtualizedVirtualSpace

        public VirtualSpace getVirtualizedVirtualSpace​(@FullVSRef java.lang.String path)
        Gets a virtualized VirtualSpace for the application session from this virtualized VirtualSpace. The VirtualSpace to get MUST already have been virtualized prior to this call.
        Specified by:
        getVirtualizedVirtualSpace in interface IVSComponent
        Parameters:
        path - The path of the VirtualSpace name relative the parent of the current VirtualSpace. This path can be e.g. just a plain name for a direct sibling of this VirtualSpace, a folder based path such as "folder/virtualSpaceB" or a full reference path as "module:/vs/[folderPath/]virtualSpace".
        Returns:
        The VirtualSpace with the specified path, never null.
        Throws:
        NotFoundException - If the VirtualSpace is not found within the virtualized VirtualSpaces.
        java.lang.IllegalStateException - If this VirtualSpace is not virtualized or the application session gyro is not found.
        java.lang.IllegalArgumentException - If path is invalid.
      • getClassReference

        public ClassReference getClassReference()
        Gets the ClassReference in the property container from the ClassReference instance.
        Returns:
        The resolved class reference instance, null if not resolved or found.
      • getClassReferenceAtom

        public Atom getClassReferenceAtom​(java.lang.String id)
        Gets the ClassReference atom name.
        Specified by:
        getClassReferenceAtom in interface IClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        Returns:
        The class reference atom name for the ID.
      • getClassReference

        public ClassReference getClassReference​(java.lang.String id,
                                                boolean doCreateIfNotPresent)
        Gets or creates the ClassReference in the property container.
        Specified by:
        getClassReference in interface IClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        doCreateIfNotPresent - Flag to create the property (this flag can only be true in Designer)!
        Returns:
        The resolved class reference instance, null if the ClassReference doesn't exist if the create flag is false. If flag is true, an orphan unresolved EditorClassReference instance (ONLY for the Designer).
      • isClassReferenceAnnotationBackReferenceRequired

        public boolean isClassReferenceAnnotationBackReferenceRequired​(java.lang.String id)
        Checks if the ClassReference require an annotation back-reference.
        Specified by:
        isClassReferenceAnnotationBackReferenceRequired in interface IClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        Returns:
        true, always: the annotation is required to have a back-reference on the "ref" member value pair to the ClassReference owner.
      • getClassReferenceImplementsInterface

        public java.lang.String getClassReferenceImplementsInterface​(java.lang.String id)
        Returns the required Interface.
        Specified by:
        getClassReferenceImplementsInterface in interface IClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        Returns:
        The fully qualified name of the interface for the class, or null for none. For VirtualSpace this is always null.
      • getClassReferenceRequiredAnnotation

        public java.lang.String getClassReferenceRequiredAnnotation​(java.lang.String id)
        Returns the required annotation, or null for none.
        Specified by:
        getClassReferenceRequiredAnnotation in interface IClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        Returns:
        The fully qualified name of the interface for the class, or null for none. For VirtualSpace this is always AnnotationType.VirtualSpace.fqn.
      • getParticipantsHolder

        public VSParticipantsHolder getParticipantsHolder()
        Gets participants holder container.
      • onPrepare

        protected void onPrepare​(IAppOwner appOwner,
                                 IModuleOwner moduleOwner,
                                 boolean isPostCall,
                                 java.util.List<java.lang.Throwable> errors)
                          throws PropException
        Called when the application is being prepared. The order of onPrepare calls is always parent first, the children. The method is called twice, first time with isPostCall set to false, then a second time with true.
        Overrides:
        onPrepare in class GProp<GProp<?>[]>
        Parameters:
        appOwner - The application owner.
        moduleOwner - The Module owner.
        isPostCall - Flag indicating this is a post-call.
        errors - A list of errors that occurred but did not cause an abort.
        Throws:
        PropException - For property errors during the application preparation to need to abort.
      • onVirtualizationCompleted

        protected void onVirtualizationCompleted​(IAppSessionGyro appGyro,
                                                 IClientSessionGyro clientGyro,
                                                 VirtualSpace virtualSpace,
                                                 PropCnr virtualizedProp,
                                                 boolean isPostResolve)
        Called when virtualization completed.

        This method is called to the entire tree of the newly virtualized property container.

        Overrides:
        onVirtualizationCompleted in class GProp<GProp<?>[]>
        Parameters:
        appGyro - The application gyro instance performing the virtualization.
        clientGyro - The client gyro session, can be null if not initialized from the client gyro.
        virtualSpace - The virtualized VirtualSpace.
        virtualizedProp - The property being virtualized.
        isPostResolve - Flag indicating this call is done after references are attempted to be resolved.
      • onPropDispose

        protected void onPropDispose()
        Called when a property is disposed of by delete/remove in a container, or by the dispose method.

        The Property Container clears the structure of unsent communication requests to clear memory.

        This call is done just at the end of the delete/remove routine in the container, without synchronization.

        During this call, whatever components that e.g. the client needs to disposed of is done.

        Subclasses needing to perform some intelligent operations upon deletion should do it by overloading this method and always call the super.onPropDispose() method.

        Overrides:
        onPropDispose in class PropCnr
      • getFocusHandler

        public IVSFocusHandler getFocusHandler()
        Returns the instance for the VirtualSpace focus handler.
        Returns:
        The instance to use for this VirtualSpace, null for none.
      • invokeOnVSCreateMethod

        protected void invokeOnVSCreateMethod​(IVSComponent component)
        Invoke the create event method.
        Parameters:
        component - The VirtualSpace or it's component.
      • invokeOnVSDestroyMethod

        protected void invokeOnVSDestroyMethod​(IVSComponent component)
        Invoke the destroy event method.
        Parameters:
        component - The VirtualSpace or it's component.
      • invokeOnVSActionMethod

        protected void invokeOnVSActionMethod​(VSAction action,
                                              GProp<?> trigger,
                                              UIComp contextComponent)
        Invoke the action event method.
        Parameters:
        action - The VS action.
        trigger - The trigger property.
        contextComponent - The context component, null for none.
      • invokeOnVSChangedMethod

        protected void invokeOnVSChangedMethod​(IVSComponent component,
                                               GProp<?> trigger)
        Invoke the changed event method.
        Parameters:
        component - The VS component.
        trigger - The trigger property.
      • invokeOnVSFocusMethod

        protected void invokeOnVSFocusMethod​(boolean isFocusGained,
                                             IVSComponent component,
                                             IVSComponent opposite,
                                             IGProp<?> trigger)
        Invoke the focus event method.
        Parameters:
        isFocusGained - Flag for focus gained operation.
        component - The VS component.
        opposite - The opposite VS component.
        trigger - The trigger property.
      • invokeOnVSStateMethod

        protected void invokeOnVSStateMethod​(IVSComponent component,
                                             IVSComponentState.State state,
                                             boolean stateValue,
                                             GProp<?> trigger)
        Invoke the state event method.
        Parameters:
        component - The VS component.
        state - The state.
        stateValue - The new state.
        trigger - The trigger property.
      • getField

        public VSField getField​(@VSRef java.lang.String path)
                         throws NotFoundException
        Gets the field with the specified path.
        Specified by:
        getField in interface IVSComponent
        Parameters:
        path - The path to the field in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The field, never null.
        Throws:
        NotFoundException - If the field is not found.
      • getFieldNull

        public VSField getFieldNull​(@VSRef java.lang.String path)
        Gets the field with the specified path.
        Specified by:
        getFieldNull in interface IVSComponent
        Parameters:
        path - The path to the field in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The field, null if not found.
      • getField2

        public VSField getField2​(@FullVSRef java.lang.String fullVSRef)
                          throws NotFoundException
        Gets the field with the specified full VS reference path.
        Specified by:
        getField2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the field in the VirtualSpace, as "module:/vs/path".
        Returns:
        The field, never null.
        Throws:
        NotFoundException - If the field is not found.
      • getFieldNull2

        public VSField getFieldNull2​(@FullVSRef java.lang.String fullVSRef)
        Gets the field with the specified full VS reference path.

        It is preferable to use getField2(String) instead of this method if the field always should be present because it will throw and log errors.

        Specified by:
        getFieldNull2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the field in the VirtualSpace, as "module:/vs/path".
        Returns:
        The field, null if not found.
      • getTable

        public VSTable getTable​(@VSRef java.lang.String path)
                         throws NotFoundException
        Gets the table with the specified path.
        Specified by:
        getTable in interface IVSComponent
        Parameters:
        path - The path to the table in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The table, never null.
        Throws:
        NotFoundException - If the table is not found.
      • getTableNull

        public VSTable getTableNull​(@VSRef java.lang.String path)
        Gets the table with the specified path.
        Specified by:
        getTableNull in interface IVSComponent
        Parameters:
        path - The path to the table in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The table, null if not found.
      • getTable2

        public VSTable getTable2​(@FullVSRef java.lang.String fullVSRef)
                          throws NotFoundException
        Gets the table with the specified full VS reference path.
        Specified by:
        getTable2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the table in the VirtualSpace, as "module:/vs/path".
        Returns:
        The table, never null.
        Throws:
        NotFoundException - If the table is not found.
      • getTableNull2

        public VSTable getTableNull2​(@FullVSRef java.lang.String fullVSRef)
        Gets the table with the specified full VS reference path.

        It is preferable to use getTable2(String) instead of this method if the table always should be present because it will throw and log errors.

        Specified by:
        getTableNull2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the table in the VirtualSpace, as "module:/vs/path".
        Returns:
        The field, null if not found.
      • getAction

        public VSAction getAction​(@VSRef java.lang.String path)
                           throws NotFoundException
        Gets the action with the specified path.
        Specified by:
        getAction in interface IVSComponent
        Parameters:
        path - The path to the action in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The action, never null.
        Throws:
        NotFoundException - If the action is not found.
      • getActionNull

        public VSAction getActionNull​(@VSRef java.lang.String path)
        Gets the action with the specified path.
        Specified by:
        getActionNull in interface IVSComponent
        Parameters:
        path - The path to the action in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The action, null if not found.
      • getAction2

        public VSAction getAction2​(@FullVSRef java.lang.String fullVSRef)
                            throws NotFoundException
        Gets the action with the specified full VS reference path.
        Specified by:
        getAction2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the action in the VirtualSpace, as "module:/vs/path".
        Returns:
        The action, never null.
        Throws:
        NotFoundException - If the action is not found.
      • getActionNull2

        public VSAction getActionNull2​(@FullVSRef java.lang.String fullVSRef)
        Gets the action with the specified full VS reference path.

        It is preferable to use getAction2(String) instead of this method if the action always should be present because it will throw and log errors.

        Specified by:
        getActionNull2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the field in the VirtualSpace, as "module:/vs/path".
        Returns:
        The action, null if not found.
      • getGroup

        public VSGroup getGroup​(@VSRef java.lang.String path)
                         throws NotFoundException
        Gets the group with the specified path.
        Specified by:
        getGroup in interface IVSComponent
        Parameters:
        path - The path to the group in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The group, never null.
        Throws:
        NotFoundException - If the action is not found.
      • getGroupNull

        public VSGroup getGroupNull​(@VSRef java.lang.String path)
        Gets the group with the specified path.

        It is preferable to use getGroup(String) instead of this method if the group always should be present because it will throw and log errors.

        Specified by:
        getGroupNull in interface IVSComponent
        Parameters:
        path - The path to the group in the VirtualSpace, cannot start with '/' or contain ':'.
        Returns:
        The group, null if not found.
      • getGroup2

        public VSGroup getGroup2​(@FullVSRef java.lang.String fullVSRef)
                          throws NotFoundException
        Gets the group with the specified full VS reference path.
        Specified by:
        getGroup2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the group in the VirtualSpace, as "module:/vs/path".
        Returns:
        The group, never null.
        Throws:
        NotFoundException - If the group is not found.
      • getGroupNull2

        public VSGroup getGroupNull2​(@FullVSRef java.lang.String fullVSRef)
        Gets the group with the specified full VS reference path.

        It is preferable to use getGroup2(String) instead of this method if the group always should be present because it will throw and log errors.

        Specified by:
        getGroupNull2 in interface IVSComponent
        Parameters:
        fullVSRef - The full VS reference to the group the VirtualSpace, as "module:/vs/path".
        Returns:
        The group, null if not found.
      • getVSComponent

        public <COMP extends IVSComponent> COMP getVSComponent​(@VSRef java.lang.String path,
                                                               java.lang.Class<COMP> clazz)
                                                        throws NotFoundException
        Gets the VS component with the specified path.
        Specified by:
        getVSComponent in interface IVSComponent
        Parameters:
        path - The path to the VS component in the VirtualSpace, cannot start with '/' or contain ':'.
        clazz - The requested VS component class.
        Returns:
        The component, never null or wrong class.
        Throws:
        NotFoundException - If the component is not found or wrong class.
      • getVSComponentNull

        public <COMP extends IVSComponent> COMP getVSComponentNull​(@VSRef java.lang.String path,
                                                                   java.lang.Class<COMP> clazz)
        Gets the VS component with the specified path.
        Specified by:
        getVSComponentNull in interface IVSComponent
        Parameters:
        path - The path to the VS component in the VirtualSpace, cannot start with '/' or contain ':'.
        clazz - The requested VS component class.
        Returns:
        The component, null if not found or wrong class.
      • getVSComponent2

        public <COMP extends IVSComponent> COMP getVSComponent2​(@FullVSRef java.lang.String fullVSRef,
                                                                java.lang.Class<COMP> clazz)
                                                         throws NotFoundException
        Gets the VS component with the specified full reference path.
        Specified by:
        getVSComponent2 in interface IVSComponent
        Parameters:
        fullVSRef - The full reference path to the VS component in the VirtualSpace, as "module:/vs/path".
        clazz - The requested VS component class.
        Returns:
        The component, never null or wrong class.
        Throws:
        NotFoundException - If the component is not found or wrong class.
      • getVSComponentNull2

        public <COMP extends IVSComponent> COMP getVSComponentNull2​(@FullVSRef java.lang.String fullVSRef,
                                                                    java.lang.Class<COMP> clazz)
        Gets the VS component with the specified full reference path.
        Specified by:
        getVSComponentNull2 in interface IVSComponent
        Parameters:
        fullVSRef - The full reference path to the VS component in the VirtualSpace, as "module:/vs/path".
        clazz - The requested VS component class.
        Returns:
        The component, null if not found or wrong class.
      • getPrivateStorageMap

        public java.util.Map<java.lang.String,​java.lang.Object> getPrivateStorageMap()
        Gets the concurrent hash map used to store the private data.
        Specified by:
        getPrivateStorageMap in interface IPrivateStorage
        Returns:
        The private storage map.