Bug 1848: Make sure that XmlStreamUtils preserve list key order.
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / MutableCompositeNodeTOImpl.java
index 975c2a9795d0ba40c263614ef14b1795e987bfbd..45aabc3c579195e642d1f4aec168d05fe0eb5031 100644 (file)
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.yang.data.impl;\r
-\r
-import org.opendaylight.yangtools.yang.common.QName;\r
-import org.opendaylight.yangtools.yang.data.api.CompositeNode;\r
-import org.opendaylight.yangtools.yang.data.api.ModifyAction;\r
-import org.opendaylight.yangtools.yang.data.api.MutableCompositeNode;\r
-import org.opendaylight.yangtools.yang.data.api.Node;\r
-import org.opendaylight.yangtools.yang.data.api.SimpleNode;\r
-\r
-import java.io.IOException;\r
-import java.io.ObjectInputStream;\r
-import java.io.ObjectOutputStream;\r
-import java.io.Serializable;\r
-import java.util.ArrayList;\r
-import java.util.Collection;\r
-import java.util.Collections;\r
-import java.util.HashMap;\r
-import java.util.List;\r
-import java.util.Map;\r
-import java.util.Set;\r
-\r
-/**\r
- * @author michal.rehak\r
- * \r
- */\r
-public class MutableCompositeNodeTOImpl extends AbstractNodeTO<List<Node<?>>> implements MutableCompositeNode, Serializable {\r
-\r
-    private static final long serialVersionUID = 100L;\r
-\r
-    private Map<QName, List<Node<?>>> nodeMap = new HashMap<>();\r
-    private CompositeNode original;\r
-\r
-    public MutableCompositeNodeTOImpl(QName qname, CompositeNode parent, List<Node<?>> value, ModifyAction modifyAction) {\r
-        super(qname, parent, value, modifyAction);\r
-        init();\r
-    }\r
-\r
-    /**\r
-     * update nodeMap - it should be invoked after children was changed\r
-     */\r
-    @Override\r
-    public void init() {\r
-        if (!getChildren().isEmpty()) {\r
-            nodeMap = NodeUtils.buildNodeMap(getChildren());\r
-        }\r
-    }\r
-\r
-    @Override\r
-    public List<Node<?>> getChildren() {\r
-        return getValue() == null ? new ArrayList<Node<?>>() : getValue();\r
-    }\r
-\r
-    @Override\r
-    public List<Node<?>> setValue(List<Node<?>> value) {\r
-        List<Node<?>> oldVal = super.setValue(value);\r
-        init();\r
-        return oldVal;\r
-    }\r
-\r
-    @Override\r
-    public void setModifyAction(ModifyAction action) {\r
-        super.setModificationAction(action);\r
-    }\r
-\r
-    protected Map<QName, List<Node<?>>> getNodeMap() {\r
-        return nodeMap;\r
-    }\r
-\r
-    @Override\r
-    public MutableCompositeNode asMutable() {\r
-        return this;\r
-    }\r
-\r
-    @Override\r
-    public CompositeNode getOriginal() {\r
-        return original;\r
-    }\r
-\r
-    /**\r
-     * @param original\r
-     *            the original to set\r
-     */\r
-    public void setOriginal(CompositeNode original) {\r
-        this.original = original;\r
-    }\r
-\r
-    @Override\r
-    public SimpleNode<?> getFirstSimpleByName(QName leafQName) {\r
-        List<SimpleNode<?>> list = getSimpleNodesByName(leafQName);\r
-        if (list.isEmpty()) {\r
-            return null;\r
-        }\r
-        return list.get(0);\r
-    }\r
-\r
-    @Override\r
-    public List<CompositeNode> getCompositesByName(QName children) {\r
-        List<Node<?>> toFilter = getNodeMap().get(children);\r
-        if (toFilter == null) {\r
-            return Collections.emptyList();\r
-        }\r
-        List<CompositeNode> list = new ArrayList<CompositeNode>();\r
-        for (Node<?> node : toFilter) {\r
-            if (node instanceof CompositeNode) {\r
-                list.add((CompositeNode) node);\r
-            }\r
-        }\r
-        return list;\r
-    }\r
-\r
-    @Override\r
-    public List<SimpleNode<?>> getSimpleNodesByName(QName children) {\r
-        List<Node<?>> toFilter = getNodeMap().get(children);\r
-        if (toFilter == null) {\r
-            return Collections.emptyList();\r
-        }\r
-        List<SimpleNode<?>> list = new ArrayList<SimpleNode<?>>();\r
-\r
-        for (Node<?> node : toFilter) {\r
-            if (node instanceof SimpleNode<?>) {\r
-                list.add((SimpleNode<?>) node);\r
-            }\r
-        }\r
-        return list;\r
-    }\r
-\r
-    @Override\r
-    public CompositeNode getFirstCompositeByName(QName container) {\r
-        List<CompositeNode> list = getCompositesByName(container);\r
-        if (list.isEmpty()) {\r
-            return null;\r
-        }\r
-        return list.get(0);\r
-    }\r
-\r
-    /**\r
-     * @param leaf\r
-     * @return TODO:: do we need this method?\r
-     */\r
-    public SimpleNode<?> getFirstLeafByName(QName leaf) {\r
-        List<SimpleNode<?>> list = getSimpleNodesByName(leaf);\r
-        if (list.isEmpty()) {\r
-            return null;\r
-        }\r
-        return list.get(0);\r
-    }\r
-\r
-    @Override\r
-    public List<CompositeNode> getCompositesByName(String children) {\r
-        return getCompositesByName(new QName(getNodeType(), children));\r
-    }\r
-\r
-    @Override\r
-    public List<SimpleNode<?>> getSimpleNodesByName(String children) {\r
-        return getSimpleNodesByName(new QName(getNodeType(), children));\r
-    }\r
-\r
-    @Override\r
-    public String toString() {\r
-        return super.toString() + ", children.size = " + (getChildren() != null ? getChildren().size() : "n/a");\r
-    }\r
-\r
-    @Override\r
-    public void clear() {\r
-        nodeMap.clear();\r
-    }\r
-\r
-    @Override\r
-    public boolean containsKey(Object key) {\r
-        return nodeMap.containsKey(key);\r
-    }\r
-\r
-    @Override\r
-    public boolean containsValue(Object value) {\r
-        return nodeMap.containsValue(value);\r
-    }\r
-\r
-    @Override\r
-    public Set<java.util.Map.Entry<QName, List<Node<?>>>> entrySet() {\r
-        return nodeMap.entrySet();\r
-    }\r
-\r
-    @Override\r
-    public boolean equals(Object obj) {\r
-        return super.equals(obj);\r
-    }\r
-\r
-    @Override\r
-    public int size() {\r
-        return nodeMap.size();\r
-    }\r
-\r
-    @Override\r
-    public boolean isEmpty() {\r
-        return nodeMap.isEmpty();\r
-    }\r
-\r
-    @Override\r
-    public List<Node<?>> get(Object key) {\r
-        return nodeMap.get(key);\r
-    }\r
-\r
-    @Override\r
-    public List<Node<?>> put(QName key, List<Node<?>> value) {\r
-        return nodeMap.put(key, value);\r
-    }\r
-\r
-    @Override\r
-    public List<Node<?>> remove(Object key) {\r
-        return nodeMap.remove(key);\r
-    }\r
-\r
-    @Override\r
-    public void putAll(Map<? extends QName, ? extends List<Node<?>>> m) {\r
-        nodeMap.putAll(m);\r
-    }\r
-\r
-    @Override\r
-    public Set<QName> keySet() {\r
-        return nodeMap.keySet();\r
-    }\r
-\r
-    @Override\r
-    public Collection<List<Node<?>>> values() {\r
-        return nodeMap.values();\r
-    }\r
-\r
-  // Serialization related\r
-\r
-    private void readObject(ObjectInputStream aStream) throws IOException, ClassNotFoundException {\r
-        aStream.defaultReadObject();\r
-        QName qName = (QName)aStream.readObject();\r
-        CompositeNode parent = (CompositeNode) aStream.readObject();\r
-        List<Node<?>> value = (List<Node<?>>) aStream.readObject();\r
-        ModifyAction modifyAction = (ModifyAction) aStream.readObject();\r
-\r
-        init(qName, parent, value, modifyAction);\r
-    }\r
-\r
-    private void writeObject(ObjectOutputStream aStream) throws IOException {\r
-        aStream.defaultWriteObject();\r
-        //manually serialize superclass\r
-        aStream.writeObject(getQName());\r
-        aStream.writeObject(getParent());\r
-        aStream.writeObject(getValue());\r
-        aStream.writeObject(getModificationAction());\r
-    }\r
-}\r
+/*
+ * Copyright (c) 2013 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.yangtools.yang.data.impl;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.CompositeNode;
+import org.opendaylight.yangtools.yang.data.api.ModifyAction;
+import org.opendaylight.yangtools.yang.data.api.MutableCompositeNode;
+import org.opendaylight.yangtools.yang.data.api.Node;
+import org.opendaylight.yangtools.yang.data.api.SimpleNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
+
+/**
+ * @author michal.rehak
+ *
+ * @deprecated Use one of the {@link NormalizedNodeContainer} implementations instead.
+ */
+@Deprecated
+public class MutableCompositeNodeTOImpl extends AbstractNodeTO<List<Node<?>>> implements MutableCompositeNode, Serializable {
+
+    private static final long serialVersionUID = 100L;
+
+    private Map<QName, List<Node<?>>> nodeMap = new HashMap<>();
+    private CompositeNode original;
+
+    public MutableCompositeNodeTOImpl(final QName qname, final CompositeNode parent, final List<Node<?>> value, final ModifyAction modifyAction) {
+        super(qname, parent, value, modifyAction);
+        init();
+    }
+
+    /**
+     * update nodeMap - it should be invoked after children was changed
+     */
+    @Override
+    public void init() {
+        if (!getChildren().isEmpty()) {
+            nodeMap = NodeUtils.buildNodeMap(getChildren());
+        }
+    }
+
+    @Override
+    public List<Node<?>> getChildren() {
+        return getValue() == null ? new ArrayList<Node<?>>() : getValue();
+    }
+
+    @Override
+    public List<Node<?>> setValue(final List<Node<?>> value) {
+        List<Node<?>> oldVal = super.setValue(value);
+        init();
+        return oldVal;
+    }
+
+    @Override
+    public void setModifyAction(final ModifyAction action) {
+        super.setModificationAction(action);
+    }
+
+    protected Map<QName, List<Node<?>>> getNodeMap() {
+        return nodeMap;
+    }
+
+    @Override
+    public MutableCompositeNode asMutable() {
+        return this;
+    }
+
+    @Override
+    public CompositeNode getOriginal() {
+        return original;
+    }
+
+    /**
+     * @param original
+     *            the original to set
+     */
+    public void setOriginal(final CompositeNode original) {
+        this.original = original;
+    }
+
+    @Override
+    public SimpleNode<?> getFirstSimpleByName(final QName leafQName) {
+        List<SimpleNode<?>> list = getSimpleNodesByName(leafQName);
+        if (list.isEmpty()) {
+            return null;
+        }
+        return list.get(0);
+    }
+
+    @Override
+    public List<CompositeNode> getCompositesByName(final QName children) {
+        List<Node<?>> toFilter = getNodeMap().get(children);
+        if (toFilter == null) {
+            return Collections.emptyList();
+        }
+        List<CompositeNode> list = new ArrayList<CompositeNode>();
+        for (Node<?> node : toFilter) {
+            if (node instanceof CompositeNode) {
+                list.add((CompositeNode) node);
+            }
+        }
+        return list;
+    }
+
+    @Override
+    public List<SimpleNode<?>> getSimpleNodesByName(final QName children) {
+        List<Node<?>> toFilter = getNodeMap().get(children);
+        if (toFilter == null) {
+            return Collections.emptyList();
+        }
+        List<SimpleNode<?>> list = new ArrayList<SimpleNode<?>>();
+
+        for (Node<?> node : toFilter) {
+            if (node instanceof SimpleNode<?>) {
+                list.add((SimpleNode<?>) node);
+            }
+        }
+        return list;
+    }
+
+    @Override
+    public CompositeNode getFirstCompositeByName(final QName container) {
+        List<CompositeNode> list = getCompositesByName(container);
+        if (list.isEmpty()) {
+            return null;
+        }
+        return list.get(0);
+    }
+
+    /**
+     * @param leaf
+     * @return TODO:: do we need this method?
+     */
+    public SimpleNode<?> getFirstLeafByName(final QName leaf) {
+        List<SimpleNode<?>> list = getSimpleNodesByName(leaf);
+        if (list.isEmpty()) {
+            return null;
+        }
+        return list.get(0);
+    }
+
+    @Override
+    public List<CompositeNode> getCompositesByName(final String children) {
+        return getCompositesByName(QName.create(getNodeType(), children));
+    }
+
+    @Override
+    public List<SimpleNode<?>> getSimpleNodesByName(final String children) {
+        return getSimpleNodesByName(QName.create(getNodeType(), children));
+    }
+
+    @Override
+    public String toString() {
+        return super.toString() + ", children.size = " + (getChildren() != null ? getChildren().size() : "n/a");
+    }
+
+    @Override
+    public void clear() {
+        nodeMap.clear();
+    }
+
+    @Override
+    public boolean containsKey(final Object key) {
+        return nodeMap.containsKey(key);
+    }
+
+    @Override
+    public boolean containsValue(final Object value) {
+        return nodeMap.containsValue(value);
+    }
+
+    @Override
+    public Set<java.util.Map.Entry<QName, List<Node<?>>>> entrySet() {
+        return nodeMap.entrySet();
+    }
+
+    @Override
+    public int size() {
+        return nodeMap.size();
+    }
+
+    @Override
+    public boolean isEmpty() {
+        return nodeMap.isEmpty();
+    }
+
+    @Override
+    public List<Node<?>> get(final Object key) {
+        return nodeMap.get(key);
+    }
+
+    @Override
+    public List<Node<?>> put(final QName key, final List<Node<?>> value) {
+        return nodeMap.put(key, value);
+    }
+
+    @Override
+    public List<Node<?>> remove(final Object key) {
+        return nodeMap.remove(key);
+    }
+
+    @Override
+    public void putAll(final Map<? extends QName, ? extends List<Node<?>>> m) {
+        nodeMap.putAll(m);
+    }
+
+    @Override
+    public Set<QName> keySet() {
+        return nodeMap.keySet();
+    }
+
+    @Override
+    public Collection<List<Node<?>>> values() {
+        return nodeMap.values();
+    }
+
+    // Serialization related
+
+    private void readObject(final ObjectInputStream aStream) throws IOException, ClassNotFoundException {
+        aStream.defaultReadObject();
+        QName qName = (QName)aStream.readObject();
+        CompositeNode parent = (CompositeNode) aStream.readObject();
+        @SuppressWarnings("unchecked")
+        List<Node<?>> value = (List<Node<?>>) aStream.readObject();
+        ModifyAction modifyAction = (ModifyAction) aStream.readObject();
+
+        init(qName, parent, value, modifyAction);
+    }
+
+    private void writeObject(final ObjectOutputStream aStream) throws IOException {
+        aStream.defaultWriteObject();
+        //manually serialize superclass
+        aStream.writeObject(getQName());
+        aStream.writeObject(getParent());
+        aStream.writeObject(getValue());
+        aStream.writeObject(getModificationAction());
+    }
+}