[1139] Add tree description

Bug: #1139
Signed-off-by: Pierre-Charles David <[email protected]>

backend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/description/TreeDescription.java

@@ -0,0 +1,215 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.components.forms.description;
+
+import java.text.MessageFormat;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.Function;
+
+import org.eclipse.sirius.components.annotations.Immutable;
+import org.eclipse.sirius.components.representations.VariableManager;
+
+/**
+ * The description of the tree widget.
+ *
+ * @author pcdavid
+ */
+@Immutable
+public final class TreeDescription extends AbstractWidgetDescription {
+
+    private Function<VariableManager, String> idProvider;
+
+    private Function<VariableManager, String> labelProvider;
+
+    private Function<VariableManager, String> nodeIdProvider;
+
+    private Function<VariableManager, String> nodeLabelProvider;
+
+    private Function<VariableManager, String> nodeKindProvider;
+
+    private Function<VariableManager, String> nodeImageURLProvider;
+
+    private Function<VariableManager, Boolean> nodeSelectableProvider;
+
+    private Function<VariableManager, List<?>> childrenProvider;
+
+    private Function<VariableManager, List<String>> expandedNodeIdsProvider;
+
+    private TreeDescription() {
+        // Prevent instantiation
+    }
+
+    public Function<VariableManager, String> getIdProvider() {
+        return this.idProvider;
+    }
+
+    public Function<VariableManager, String> getLabelProvider() {
+        return this.labelProvider;
+    }
+
+    public Function<VariableManager, List<?>> getChildrenProvider() {
+        return this.childrenProvider;
+    }
+
+    public Function<VariableManager, String> getNodeIdProvider() {
+        return this.nodeIdProvider;
+    }
+
+    public Function<VariableManager, String> getNodeLabelProvider() {
+        return this.nodeLabelProvider;
+    }
+
+    public Function<VariableManager, String> getNodeKindProvider() {
+        return this.nodeKindProvider;
+    }
+
+    public Function<VariableManager, String> getNodeImageURLProvider() {
+        return this.nodeImageURLProvider;
+    }
+
+    public Function<VariableManager, Boolean> getNodeSelectableProvider() {
+        return this.nodeSelectableProvider;
+    }
+
+    public Function<VariableManager, List<String>> getExpandedNodeIdsProvider() {
+        return this.expandedNodeIdsProvider;
+    }
+
+    public static Builder newTreeDescription(String id) {
+        return new Builder(id);
+    }
+
+    @Override
+    public String toString() {
+        String pattern = "{0} '{'id: {1}'}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.getId());
+    }
+
+    /**
+     * Builder used to create the list description.
+     *
+     * @author sbegaudeau
+     */
+    @SuppressWarnings("checkstyle:HiddenField")
+    public static final class Builder {
+        private String id;
+
+        private Function<VariableManager, String> idProvider;
+
+        private Function<VariableManager, String> labelProvider;
+
+        private Function<VariableManager, List<?>> childrenProvider;
+
+        private Function<VariableManager, String> nodeIdProvider;
+
+        private Function<VariableManager, String> nodeLabelProvider;
+
+        private Function<VariableManager, String> nodeKindProvider;
+
+        private Function<VariableManager, String> nodeImageURLProvider;
+
+        private Function<VariableManager, Boolean> nodeSelectableProvider;
+
+        private Function<VariableManager, List<String>> expandedNodeIdsProvider;
+
+        private Function<VariableManager, List<?>> diagnosticsProvider;
+
+        private Function<Object, String> kindProvider;
+
+        private Function<Object, String> messageProvider;
+
+        private Builder(String id) {
+            this.id = Objects.requireNonNull(id);
+        }
+
+        public Builder idProvider(Function<VariableManager, String> idProvider) {
+            this.idProvider = Objects.requireNonNull(idProvider);
+            return this;
+        }
+
+        public Builder labelProvider(Function<VariableManager, String> labelProvider) {
+            this.labelProvider = Objects.requireNonNull(labelProvider);
+            return this;
+        }
+
+        public Builder childrenProvider(Function<VariableManager, List<?>> childrenProvider) {
+            this.childrenProvider = Objects.requireNonNull(childrenProvider);
+            return this;
+        }
+
+        public Builder nodeIdProvider(Function<VariableManager, String> nodeIdProvider) {
+            this.nodeIdProvider = Objects.requireNonNull(nodeIdProvider);
+            return this;
+        }
+
+        public Builder nodeLabelProvider(Function<VariableManager, String> nodeLabelProvider) {
+            this.nodeLabelProvider = Objects.requireNonNull(nodeLabelProvider);
+            return this;
+        }
+
+        public Builder nodeKindProvider(Function<VariableManager, String> nodeKindProvider) {
+            this.nodeKindProvider = Objects.requireNonNull(nodeKindProvider);
+            return this;
+        }
+
+        public Builder nodeImageURLProvider(Function<VariableManager, String> nodeImageURLProvider) {
+            this.nodeImageURLProvider = Objects.requireNonNull(nodeImageURLProvider);
+            return this;
+        }
+
+        public Builder nodeSelectableProvider(Function<VariableManager, Boolean> nodeSelectableProvider) {
+            this.nodeSelectableProvider = Objects.requireNonNull(nodeSelectableProvider);
+            return this;
+        }
+
+        public Builder expandedNodeIdsProvider(Function<VariableManager, List<String>> expandedNodeIdsProvider) {
+            this.expandedNodeIdsProvider = Objects.requireNonNull(expandedNodeIdsProvider);
+            return this;
+        }
+
+        public Builder diagnosticsProvider(Function<VariableManager, List<?>> diagnosticsProvider) {
+            this.diagnosticsProvider = Objects.requireNonNull(diagnosticsProvider);
+            return this;
+        }
+
+        public Builder kindProvider(Function<Object, String> kindProvider) {
+            this.kindProvider = Objects.requireNonNull(kindProvider);
+            return this;
+        }
+
+        public Builder messageProvider(Function<Object, String> messageProvider) {
+            this.messageProvider = Objects.requireNonNull(messageProvider);
+            return this;
+        }
+
+        public TreeDescription build() {
+            TreeDescription treeDescription = new TreeDescription();
+            treeDescription.id = Objects.requireNonNull(this.id);
+            treeDescription.idProvider = Objects.requireNonNull(this.idProvider);
+            treeDescription.labelProvider = Objects.requireNonNull(this.labelProvider);
+            treeDescription.childrenProvider = Objects.requireNonNull(this.childrenProvider);
+            treeDescription.nodeIdProvider = Objects.requireNonNull(this.nodeIdProvider);
+            treeDescription.nodeLabelProvider = Objects.requireNonNull(this.nodeLabelProvider);
+            treeDescription.nodeKindProvider = Objects.requireNonNull(this.nodeKindProvider);
+            treeDescription.nodeImageURLProvider = Objects.requireNonNull(this.nodeImageURLProvider);
+            treeDescription.nodeSelectableProvider = Objects.requireNonNull(this.nodeSelectableProvider);
+            treeDescription.expandedNodeIdsProvider = Objects.requireNonNull(this.expandedNodeIdsProvider);
+            treeDescription.diagnosticsProvider = Objects.requireNonNull(this.diagnosticsProvider);
+            treeDescription.kindProvider = Objects.requireNonNull(this.kindProvider);
+            treeDescription.messageProvider = Objects.requireNonNull(this.messageProvider);
+            return treeDescription;
+        }
+    }
+
+}