Switch default stream output to Magnesium
[controller.git] / opendaylight / md-sal / sal-clustering-commons / src / main / java / org / opendaylight / controller / cluster / datastore / node / utils / stream / AbstractNormalizedNodeDataOutput.java
old mode 100644 (file)
new mode 100755 (executable)
index abe1f8c..d8e021f
@@ -7,35 +7,43 @@
  */
 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
 import java.io.DataOutput;
 import java.io.IOException;
 import java.io.OutputStream;
-import java.nio.charset.StandardCharsets;
-import java.util.Collection;
-import java.util.Map;
-import java.util.Set;
+import java.util.List;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
+/**
+ * Abstract base class for implementing {@link NormalizedNodeDataOutput} contract. This class uses
+ * {@link NormalizedNodeStreamWriter} as an internal interface for performing the actual NormalizedNode writeout,
+ * i.e. it will defer to a {@link NormalizedNodeWriter} instance.
+ *
+ * <p>
+ * As such, this is an implementation detail not exposed from this package, hence implementations can rely on the
+ * stream being initialized with a header and version.
+ */
 abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOutput, NormalizedNodeStreamWriter {
-    private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodeDataOutput.class);
-
-    private final DataOutput output;
+    // Visible for subclasses
+    final DataOutput output;
 
     private NormalizedNodeWriter normalizedNodeWriter;
     private boolean headerWritten;
-    private QName lastLeafSetQName;
 
     AbstractNormalizedNodeDataOutput(final DataOutput output) {
-        this.output = Preconditions.checkNotNull(output);
+        this.output = requireNonNull(output);
     }
 
+
     private void ensureHeaderWritten() throws IOException {
         if (!headerWritten) {
             output.writeByte(TokenTypes.SIGNATURE_MARKER);
@@ -44,246 +52,131 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut
         }
     }
 
-    protected abstract short streamVersion();
-    protected abstract void writeQName(QName qname) throws IOException;
-    protected abstract void writeString(String string) throws IOException;
-
     @Override
-    public final void write(final int b) throws IOException {
+    public final void write(final int value) throws IOException {
         ensureHeaderWritten();
-        output.write(b);
+        output.write(value);
     }
 
     @Override
-    public final void write(final byte[] b) throws IOException {
+    public final void write(final byte[] bytes) throws IOException {
         ensureHeaderWritten();
-        output.write(b);
+        output.write(bytes);
     }
 
     @Override
-    public final void write(final byte[] b, final int off, final int len) throws IOException {
+    public final void write(final byte[] bytes, final int off, final int len) throws IOException {
         ensureHeaderWritten();
-        output.write(b, off, len);
+        output.write(bytes, off, len);
     }
 
     @Override
-    public final void writeBoolean(final boolean v) throws IOException {
+    public final void writeBoolean(final boolean value) throws IOException {
         ensureHeaderWritten();
-        output.writeBoolean(v);
+        output.writeBoolean(value);
     }
 
     @Override
-    public final void writeByte(final int v) throws IOException {
+    public final void writeByte(final int value) throws IOException {
         ensureHeaderWritten();
-        output.writeByte(v);
+        output.writeByte(value);
     }
 
     @Override
-    public final void writeShort(final int v) throws IOException {
+    public final void writeShort(final int value) throws IOException {
         ensureHeaderWritten();
-        output.writeShort(v);
+        output.writeShort(value);
     }
 
     @Override
-    public final void writeChar(final int v) throws IOException {
+    public final void writeChar(final int value) throws IOException {
         ensureHeaderWritten();
-        output.writeChar(v);
+        output.writeChar(value);
     }
 
     @Override
-    public final void writeInt(final int v) throws IOException {
+    public final void writeInt(final int value) throws IOException {
         ensureHeaderWritten();
-        output.writeInt(v);
+        output.writeInt(value);
     }
 
     @Override
-    public final void writeLong(final long v) throws IOException {
+    public final void writeLong(final long value) throws IOException {
         ensureHeaderWritten();
-        output.writeLong(v);
+        output.writeLong(value);
     }
 
     @Override
-    public final void writeFloat(final float v) throws IOException {
+    public final void writeFloat(final float value) throws IOException {
         ensureHeaderWritten();
-        output.writeFloat(v);
+        output.writeFloat(value);
     }
 
     @Override
-    public final void writeDouble(final double v) throws IOException {
+    public final void writeDouble(final double value) throws IOException {
         ensureHeaderWritten();
-        output.writeDouble(v);
+        output.writeDouble(value);
     }
 
     @Override
-    public final void writeBytes(final String s) throws IOException {
+    public final void writeBytes(final String str) throws IOException {
         ensureHeaderWritten();
-        output.writeBytes(s);
+        output.writeBytes(str);
     }
 
     @Override
-    public final void writeChars(final String s) throws IOException {
+    public final void writeChars(final String str) throws IOException {
         ensureHeaderWritten();
-        output.writeChars(s);
+        output.writeChars(str);
     }
 
     @Override
-    public final void writeUTF(final String s) throws IOException {
+    public final void writeUTF(final String str) throws IOException {
         ensureHeaderWritten();
-        output.writeUTF(s);
-    }
-
-    private NormalizedNodeWriter normalizedNodeWriter() {
-        if(normalizedNodeWriter == null) {
-            normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
-        }
-
-        return normalizedNodeWriter;
+        output.writeUTF(str);
     }
 
     @Override
-    public void writeNormalizedNode(final NormalizedNode<?, ?> node) throws IOException {
+    public final void writeQName(final QName qname) throws IOException {
         ensureHeaderWritten();
-        normalizedNodeWriter().write(node);
-    }
-
-    @Override
-    public void leafNode(final YangInstanceIdentifier.NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Writing a new leaf node");
-        startNode(name.getNodeType(), NodeTypes.LEAF_NODE);
-
-        writeObject(value);
-    }
-
-    @Override
-    public void startLeafSet(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new leaf set");
-
-        lastLeafSetQName = name.getNodeType();
-        startNode(name.getNodeType(), NodeTypes.LEAF_SET);
-    }
-
-    @Override
-    public void startOrderedLeafSet(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new ordered leaf set");
-
-        lastLeafSetQName = name.getNodeType();
-        startNode(name.getNodeType(), NodeTypes.ORDERED_LEAF_SET);
+        writeQNameInternal(qname);
     }
 
     @Override
-    public void leafSetEntryNode(final QName name, final Object value) throws IOException, IllegalArgumentException {
-        LOG.debug("Writing a new leaf set entry node");
-
-        output.writeByte(NodeTypes.LEAF_SET_ENTRY_NODE);
-
-        // lastLeafSetQName is set if the parent LeafSetNode was previously written. Otherwise this is a
-        // stand alone LeafSetEntryNode so write out it's name here.
-        if(lastLeafSetQName == null) {
-            writeQName(name);
+    public final void writeNormalizedNode(final NormalizedNode<?, ?> node) throws IOException {
+        ensureHeaderWritten();
+        if (normalizedNodeWriter == null) {
+            normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
         }
-
-        writeObject(value);
+        normalizedNodeWriter.write(node);
     }
 
     @Override
-    public void startContainerNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-
-        LOG.debug("Starting a new container node");
-
-        startNode(name.getNodeType(), NodeTypes.CONTAINER_NODE);
-    }
-
-    @Override
-    public void startYangModeledAnyXmlNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-
-        LOG.debug("Starting a new yang modeled anyXml node");
-
-        startNode(name.getNodeType(), NodeTypes.YANG_MODELED_ANY_XML_NODE);
-    }
-
-    @Override
-    public void startUnkeyedList(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new unkeyed list");
-
-        startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST);
-    }
-
-    @Override
-    public void startUnkeyedListItem(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalStateException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new unkeyed list item");
-
-        startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST_ITEM);
-    }
-
-    @Override
-    public void startMapNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new map node");
-
-        startNode(name.getNodeType(), NodeTypes.MAP_NODE);
-    }
-
-    @Override
-    public void startMapEntryNode(final YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(identifier, "Node identifier should not be null");
-        LOG.debug("Starting a new map entry node");
-        startNode(identifier.getNodeType(), NodeTypes.MAP_ENTRY_NODE);
-
-        writeKeyValueMap(identifier.getKeyValues());
-
-    }
-
-    @Override
-    public void startOrderedMapNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new ordered map node");
-
-        startNode(name.getNodeType(), NodeTypes.ORDERED_MAP_NODE);
-    }
-
-    @Override
-    public void startChoiceNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Starting a new choice node");
-
-        startNode(name.getNodeType(), NodeTypes.CHOICE_NODE);
-    }
-
-    @Override
-    public void startAugmentationNode(final YangInstanceIdentifier.AugmentationIdentifier identifier) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(identifier, "Node identifier should not be null");
-        LOG.debug("Starting a new augmentation node");
-
-        output.writeByte(NodeTypes.AUGMENTATION_NODE);
-        writeQNameSet(identifier.getPossibleChildNames());
+    public final void writePathArgument(final PathArgument pathArgument) throws IOException {
+        ensureHeaderWritten();
+        writePathArgumentInternal(pathArgument);
     }
 
     @Override
-    public void anyxmlNode(final YangInstanceIdentifier.NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
-        Preconditions.checkNotNull(name, "Node identifier should not be null");
-        LOG.debug("Writing a new xml node");
-
-        startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE);
-
-        writeObject(value);
+    public final void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
+        ensureHeaderWritten();
+        writeYangInstanceIdentifierInternal(identifier);
     }
 
     @Override
-    public void endNode() throws IOException, IllegalStateException {
-        LOG.debug("Ending the node");
+    public final void writeSchemaPath(final SchemaPath path) throws IOException {
+        ensureHeaderWritten();
 
-        output.writeByte(NodeTypes.END_NODE);
+        output.writeBoolean(path.isAbsolute());
+        final List<QName> qnames = path.getPath();
+        output.writeInt(qnames.size());
+        for (QName qname : qnames) {
+            writeQNameInternal(qname);
+        }
     }
 
     @Override
-    public void close() throws IOException {
+    public final void close() throws IOException {
         flush();
     }
 
@@ -294,162 +187,17 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut
         }
     }
 
-    private void startNode(final QName qName, final byte nodeType) throws IOException {
-
-        Preconditions.checkNotNull(qName, "QName of node identifier should not be null.");
-
-        ensureHeaderWritten();
-
-        // First write the type of node
-        output.writeByte(nodeType);
-        // Write Start Tag
-        writeQName(qName);
-    }
-
-    private void writeObjSet(final Set<?> set) throws IOException {
-        output.writeInt(set.size());
-        for (Object o : set) {
-            Preconditions.checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)",
-                o.getClass(), o);
-
-            writeString((String) o);
-        }
-    }
-
     @Override
-    public void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
-        ensureHeaderWritten();
-        writeYangInstanceIdentifierInternal(identifier);
+    public final boolean startAnydataNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        // FIXME: We do not support anydata nodes of any kind, yet
+        return false;
     }
 
-    private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
-        Collection<YangInstanceIdentifier.PathArgument> pathArguments = identifier.getPathArguments();
-        output.writeInt(pathArguments.size());
+    abstract short streamVersion();
 
-        for(YangInstanceIdentifier.PathArgument pathArgument : pathArguments) {
-            writePathArgument(pathArgument);
-        }
-    }
-
-    @Override
-    public void writePathArgument(final YangInstanceIdentifier.PathArgument pathArgument) throws IOException {
-
-        byte type = PathArgumentTypes.getSerializablePathArgumentType(pathArgument);
-
-        output.writeByte(type);
-
-        switch(type) {
-            case PathArgumentTypes.NODE_IDENTIFIER:
-
-                YangInstanceIdentifier.NodeIdentifier nodeIdentifier =
-                    (YangInstanceIdentifier.NodeIdentifier) pathArgument;
-
-                writeQName(nodeIdentifier.getNodeType());
-                break;
-
-            case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
-
-                YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifierWithPredicates =
-                    (YangInstanceIdentifier.NodeIdentifierWithPredicates) pathArgument;
-                writeQName(nodeIdentifierWithPredicates.getNodeType());
-
-                writeKeyValueMap(nodeIdentifierWithPredicates.getKeyValues());
-                break;
-
-            case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
-
-                YangInstanceIdentifier.NodeWithValue nodeWithValue =
-                    (YangInstanceIdentifier.NodeWithValue) pathArgument;
-
-                writeQName(nodeWithValue.getNodeType());
-                writeObject(nodeWithValue.getValue());
-                break;
+    abstract void writeQNameInternal(@NonNull QName qname) throws IOException;
 
-            case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
+    abstract void writePathArgumentInternal(PathArgument pathArgument) throws IOException;
 
-                YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
-                    (YangInstanceIdentifier.AugmentationIdentifier) pathArgument;
-
-                // No Qname in augmentation identifier
-                writeQNameSet(augmentationIdentifier.getPossibleChildNames());
-                break;
-            default :
-                throw new IllegalStateException("Unknown node identifier type is found : " + pathArgument.getClass().toString() );
-        }
-    }
-
-    private void writeKeyValueMap(final Map<QName, Object> keyValueMap) throws IOException {
-        if (keyValueMap != null && !keyValueMap.isEmpty()) {
-            output.writeInt(keyValueMap.size());
-
-            for (QName qName : keyValueMap.keySet()) {
-                writeQName(qName);
-                writeObject(keyValueMap.get(qName));
-            }
-        } else {
-            output.writeInt(0);
-        }
-    }
-
-    private void writeQNameSet(final Set<QName> children) throws IOException {
-        // Write each child's qname separately, if list is empty send count as 0
-        if (children != null && !children.isEmpty()) {
-            output.writeInt(children.size());
-            for (QName qName : children) {
-                writeQName(qName);
-            }
-        } else {
-            LOG.debug("augmentation node does not have any child");
-            output.writeInt(0);
-        }
-    }
-
-    private void writeObject(final Object value) throws IOException {
-
-        byte type = ValueTypes.getSerializableType(value);
-        // Write object type first
-        output.writeByte(type);
-
-        switch (type) {
-            case ValueTypes.BOOL_TYPE:
-                output.writeBoolean((Boolean) value);
-                break;
-            case ValueTypes.QNAME_TYPE:
-                writeQName((QName) value);
-                break;
-            case ValueTypes.INT_TYPE:
-                output.writeInt((Integer) value);
-                break;
-            case ValueTypes.BYTE_TYPE:
-                output.writeByte((Byte) value);
-                break;
-            case ValueTypes.LONG_TYPE:
-                output.writeLong((Long) value);
-                break;
-            case ValueTypes.SHORT_TYPE:
-                output.writeShort((Short) value);
-                break;
-            case ValueTypes.BITS_TYPE:
-                writeObjSet((Set<?>) value);
-                break;
-            case ValueTypes.BINARY_TYPE:
-                byte[] bytes = (byte[]) value;
-                output.writeInt(bytes.length);
-                output.write(bytes);
-                break;
-            case ValueTypes.YANG_IDENTIFIER_TYPE:
-                writeYangInstanceIdentifierInternal((YangInstanceIdentifier) value);
-                break;
-            case ValueTypes.NULL_TYPE :
-                break;
-            case ValueTypes.STRING_BYTES_TYPE:
-                final byte[] valueBytes = value.toString().getBytes(StandardCharsets.UTF_8);
-                output.writeInt(valueBytes.length);
-                output.write(valueBytes);
-                break;
-            default:
-                output.writeUTF(value.toString());
-                break;
-        }
-    }
+    abstract void writeYangInstanceIdentifierInternal(YangInstanceIdentifier identifier) throws IOException;
 }