yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  * Copyright (c) 2016 Brocade Communications Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.io.IOException;
  14 import java.util.Collections;
  15 import java.util.Map;
  16 import javax.xml.stream.XMLStreamException;
  17 import javax.xml.stream.XMLStreamWriter;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  22 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
  23 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  31
  32 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
  33         implements SchemaContextProvider {
  34     private final SchemaTracker tracker;
  35     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  36
  37     SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
  38             final SchemaTracker tracker) {
  39         super(writer);
  40         this.tracker = requireNonNull(tracker);
  41         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  42     }
  43
  44     @Override
  45     void writeValue(final XMLStreamWriter xmlWriter, final QName qname, final Object value,
  46             final SchemaNode schemaNode) throws IOException, XMLStreamException {
  47         streamUtils.writeValue(xmlWriter, schemaNode, value, qname.getModule());
  48     }
  49
  50     @Override
  51     void startList(final NodeIdentifier name) {
  52         tracker.startList(name);
  53     }
  54
  55     @Override
  56     void startListItem(final PathArgument name) throws IOException {
  57         tracker.startListItem(name);
  58         startElement(name.getNodeType());
  59     }
  60
  61     @Override
  62     public void endNode() throws IOException {
  63         final Object schema = tracker.endNode();
  64         if (schema instanceof ListSchemaNode) {
  65             // For lists, we only emit end element on the inner frame
  66             final Object parent = tracker.getParent();
  67             if (parent == schema) {
  68                 endElement();
  69             }
  70         } else if (schema instanceof ContainerSchemaNode) {
  71             // Emit container end element
  72             endElement();
  73         }
  74     }
  75
  76     @Override
  77     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
  78         final LeafSchemaNode schema = tracker.leafNode(name);
  79         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
  80     }
  81
  82     @Override
  83     public void leafNode(final NodeIdentifier name, final Object value, final Map<QName, String> attributes)
  84         throws IOException {
  85         final LeafSchemaNode schema = tracker.leafNode(name);
  86         writeElement(schema.getQName(), value, attributes, schema);
  87     }
  88
  89     @Override
  90     public void leafSetEntryNode(final QName name, final Object value, final Map<QName, String> attributes)
  91             throws IOException {
  92         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
  93         writeElement(schema.getQName(), value, attributes, schema);
  94     }
  95
  96     @Override
  97     public void leafSetEntryNode(final QName name, final Object value) throws IOException {
  98         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
  99         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
 100     }
 101
 102     @Override
 103     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 104         tracker.startLeafSet(name);
 105     }
 106
 107     @Override
 108     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 109         tracker.startLeafSet(name);
 110     }
 111
 112     @Override
 113     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 114         final SchemaNode schema = tracker.startContainerNode(name);
 115         startElement(schema.getQName());
 116     }
 117
 118     @Override
 119     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 120         tracker.startChoiceNode(name);
 121     }
 122
 123     @Override
 124     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 125         tracker.startAugmentationNode(identifier);
 126     }
 127
 128     @Override
 129     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 130         final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
 131         startElement(schema.getQName());
 132     }
 133
 134     @Override
 135     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 136         final AnyXmlSchemaNode schema = tracker.anyxmlNode(name);
 137         anyxmlNode(schema.getQName(), value);
 138     }
 139
 140     @Override
 141     public SchemaContext getSchemaContext() {
 142         return streamUtils.getSchemaContext();
 143     }
 144 }