BUG-509: Move DataTree concepts into separate package
[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / store / impl / tree / data / StoreMetadataNode.java
diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/StoreMetadataNode.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/StoreMetadataNode.java
new file mode 100644 (file)
index 0000000..abccf1d
--- /dev/null
@@ -0,0 +1,193 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.md.sal.dom.store.impl.tree.data;
+
+import static com.google.common.base.Preconditions.checkState;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.opendaylight.controller.md.sal.dom.store.impl.tree.StoreTreeNode;
+import org.opendaylight.yangtools.concepts.Identifiable;
+import org.opendaylight.yangtools.concepts.Immutable;
+import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
+
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.primitives.UnsignedLong;
+
+public class StoreMetadataNode implements Immutable, Identifiable<PathArgument>, StoreTreeNode<StoreMetadataNode> {
+
+    private final UnsignedLong nodeVersion;
+    private final UnsignedLong subtreeVersion;
+    private final NormalizedNode<?, ?> data;
+
+    private final Map<PathArgument, StoreMetadataNode> children;
+
+    /**
+     *
+     * @param data
+     * @param nodeVersion
+     * @param subtreeVersion
+     * @param children Map of children, must not be modified externally
+     */
+    protected StoreMetadataNode(final NormalizedNode<?, ?> data, final UnsignedLong nodeVersion,
+            final UnsignedLong subtreeVersion, final Map<PathArgument, StoreMetadataNode> children) {
+        this.nodeVersion = nodeVersion;
+        this.subtreeVersion = subtreeVersion;
+        this.data = data;
+        this.children = Preconditions.checkNotNull(children);
+    }
+
+    public static StoreMetadataNode createEmpty(final NormalizedNode<?, ?> data) {
+        return new StoreMetadataNode(data, UnsignedLong.ZERO, UnsignedLong.ZERO,
+                Collections.<PathArgument, StoreMetadataNode>emptyMap());
+    }
+
+    public StoreMetadataNode(final NormalizedNode<?, ?> data, final UnsignedLong nodeVersion,
+            final UnsignedLong subtreeVersion) {
+        this(data, nodeVersion, subtreeVersion, Collections.<PathArgument, StoreMetadataNode>emptyMap());
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static Builder builder(StoreMetadataNode node) {
+        return new Builder(node);
+    }
+
+    public UnsignedLong getNodeVersion() {
+        return this.nodeVersion;
+    }
+
+    @Override
+    public PathArgument getIdentifier() {
+        return data.getIdentifier();
+    }
+
+    public UnsignedLong getSubtreeVersion() {
+        return subtreeVersion;
+    }
+
+    public NormalizedNode<?, ?> getData() {
+        return this.data;
+    }
+
+    @Override
+    public Optional<StoreMetadataNode> getChild(final PathArgument key) {
+        return Optional.fromNullable(children.get(key));
+    }
+
+    @Override
+    public String toString() {
+        return "StoreMetadataNode [identifier=" + getIdentifier() + ", nodeVersion=" + nodeVersion + "]";
+    }
+
+    public static Optional<UnsignedLong> getVersion(final Optional<StoreMetadataNode> currentMetadata) {
+        if (currentMetadata.isPresent()) {
+            return Optional.of(currentMetadata.get().getNodeVersion());
+        }
+        return Optional.absent();
+    }
+
+    public static Optional<StoreMetadataNode> getChild(final Optional<StoreMetadataNode> parent,
+            final PathArgument child) {
+        if (parent.isPresent()) {
+            return parent.get().getChild(child);
+        }
+        return Optional.absent();
+    }
+
+    public static final StoreMetadataNode createRecursively(final NormalizedNode<?, ?> node,
+            final UnsignedLong nodeVersion, final UnsignedLong subtreeVersion) {
+        Builder builder = builder() //
+                .setNodeVersion(nodeVersion) //
+                .setSubtreeVersion(subtreeVersion) //
+                .setData(node);
+        if (node instanceof NormalizedNodeContainer<?, ?, ?>) {
+
+            @SuppressWarnings("unchecked")
+            NormalizedNodeContainer<?, ?, NormalizedNode<?, ?>> nodeContainer = (NormalizedNodeContainer<?, ?, NormalizedNode<?, ?>>) node;
+            for (NormalizedNode<?, ?> subNode : nodeContainer.getValue()) {
+                builder.add(createRecursively(subNode, nodeVersion, subtreeVersion));
+            }
+        }
+        return builder.build();
+    }
+
+    public static class Builder {
+
+        private UnsignedLong nodeVersion;
+        private UnsignedLong subtreeVersion;
+        private NormalizedNode<?, ?> data;
+        private Map<PathArgument, StoreMetadataNode> children;
+        private boolean dirty = false;
+
+        private Builder() {
+            children = new HashMap<>();
+        }
+
+        public Builder(StoreMetadataNode node) {
+            children = new HashMap<>(node.children);
+        }
+
+        public UnsignedLong getVersion() {
+            return nodeVersion;
+
+        }
+
+        public Builder setNodeVersion(final UnsignedLong version) {
+            this.nodeVersion = version;
+            return this;
+        }
+
+        public Builder setSubtreeVersion(final UnsignedLong version) {
+            this.subtreeVersion = version;
+            return this;
+        }
+
+        public Builder setData(final NormalizedNode<?, ?> data) {
+            this.data = data;
+            return this;
+        }
+
+        public Builder add(final StoreMetadataNode node) {
+            if (dirty) {
+                children = new HashMap<>(children);
+                dirty = false;
+            }
+            children.put(node.getIdentifier(), node);
+            return this;
+        }
+
+        public Builder remove(final PathArgument id) {
+            if (dirty) {
+                children = new HashMap<>(children);
+                dirty = false;
+            }
+            children.remove(id);
+            return this;
+        }
+
+        public StoreMetadataNode build() {
+            checkState(data != null, "Data node should not be null.");
+            checkState(subtreeVersion.compareTo(nodeVersion) >= 0,
+                    "Subtree version must be equals or greater than node version.");
+            dirty = true;
+            return new StoreMetadataNode(data, nodeVersion, subtreeVersion, children);
+        }
+    }
+
+    public static StoreMetadataNode createRecursively(final NormalizedNode<?, ?> node, final UnsignedLong version) {
+        return createRecursively(node, version, version);
+    }
+}