Class RootNode

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, ISerializableEntity, ISerializableNode

    @Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
               date="2023-08-24T23:07:44.486Z")
    @Stability(Experimental)
    public class RootNode
    extends Node
    (experimental) RootNode represents the root of the store tree.
    • Field Detail

      • PATH

        @Stability(Experimental)
        public static final String PATH
        (experimental) Fixed path of root.
      • UUID

        @Stability(Experimental)
        public static final String UUID
        (experimental) Fixed UUID of root.
    • Constructor Detail

      • RootNode

        protected RootNode​(software.amazon.jsii.JsiiObjectRef objRef)
      • RootNode

        protected RootNode​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
      • RootNode

        @Stability(Experimental)
        public RootNode​(@NotNull
                        Store store)
        Parameters:
        store - Reference to the store. This parameter is required.
    • Method Detail

      • isRootNode

        @Stability(Experimental)
        @NotNull
        public static Boolean isRootNode​(@NotNull
                                         Node node)
        (experimental) Indicates if node is a RootNode.

        Parameters:
        node - This parameter is required.
      • findAll

        @Stability(Experimental)
        @NotNull
        public List<Node> findAll​(@Nullable
                                  IFindNodeOptions options)
        (experimental) Return this construct and all of its sub-nodes in the given order.

        Optionally filter nodes based on predicate. The root not is excluded from list

        Overrides:
        findAll in class Node
        Parameters:
        options -
      • findAll

        @Stability(Experimental)
        @NotNull
        public List<Node> findAll()
        (experimental) Return this construct and all of its sub-nodes in the given order.

        Optionally filter nodes based on predicate. The root not is excluded from list

        Overrides:
        findAll in class Node
      • mutateCollapse

        @Stability(Experimental)
        public void mutateCollapse()
        (experimental) Collapses all sub-nodes of this node into this node.

        > RootNode does not support this mutation

        Overrides:
        mutateCollapse in class Node
      • mutateCollapseTo

        @Stability(Experimental)
        @NotNull
        public Node mutateCollapseTo​(@NotNull
                                     Node _ancestor)
        (experimental) Collapses *this node* into *an ancestor* > RootNode does not support this mutation.

        Overrides:
        mutateCollapseTo in class Node
        Parameters:
        _ancestor - This parameter is required.
      • mutateCollapseToParent

        @Stability(Experimental)
        @NotNull
        public Node mutateCollapseToParent()
        (experimental) Collapses *this node* into *it's parent node* > RootNode does not support this mutation.
        Overrides:
        mutateCollapseToParent in class Node
      • mutateDestroy

        @Stability(Experimental)
        public void mutateDestroy​(@Nullable
                                  Boolean _strict)
        (experimental) Destroys this node by removing all references and removing this node from the store.

        > RootNode does not support this mutation

        Overrides:
        mutateDestroy in class Node
        Parameters:
        _strict -
      • mutateDestroy

        @Stability(Experimental)
        public void mutateDestroy()
        (experimental) Destroys this node by removing all references and removing this node from the store.

        > RootNode does not support this mutation

        Overrides:
        mutateDestroy in class Node
      • mutateHoist

        @Stability(Experimental)
        public void mutateHoist​(@NotNull
                                Node _newParent)
        (experimental) Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.

        > RootNode does not support this mutation

        Overrides:
        mutateHoist in class Node
        Parameters:
        _newParent - This parameter is required.