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.
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
9 package org.opendaylight.yangtools.yang.data.codec.xml;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static com.google.common.base.Preconditions.checkState;
13 import static java.util.Objects.requireNonNull;
15 import java.io.IOException;
16 import java.util.Optional;
17 import javax.xml.stream.XMLStreamException;
18 import javax.xml.stream.XMLStreamWriter;
19 import javax.xml.transform.dom.DOMSource;
20 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
26 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
27 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
35 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
38 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
39 implements SchemaContextProvider {
40 private final SchemaTracker tracker;
41 private final SchemaAwareXMLStreamWriterUtils streamUtils;
43 SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
44 final SchemaTracker tracker) {
46 this.tracker = requireNonNull(tracker);
47 this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
51 String encodeValue(final ValueWriter xmlWriter, final Object value, final SchemaNode schemaNode)
52 throws XMLStreamException {
53 return streamUtils.encodeValue(xmlWriter, schemaNode, value, schemaNode.getQName().getModule());
57 String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
58 throws XMLStreamException {
59 final Optional<AnnotationSchemaNode> optAnnotation = AnnotationSchemaNode.find(streamUtils.getSchemaContext(),
61 if (optAnnotation.isPresent()) {
62 return streamUtils.encodeValue(xmlWriter, optAnnotation.get(), value, qname.getModule());
65 checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
66 checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
67 return (String) value;
71 void startList(final NodeIdentifier name) {
72 tracker.startList(name);
76 void startListItem(final PathArgument name) throws IOException {
77 tracker.startListItem(name);
78 startElement(name.getNodeType());
82 public void endNode() throws IOException {
83 final Object schema = tracker.endNode();
84 if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
85 // For lists, we only emit end element on the inner frame
86 final Object parent = tracker.getParent();
87 if (parent == schema) {
90 } else if (schema instanceof ContainerSchemaNode || schema instanceof LeafSchemaNode
91 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
97 public void startLeafNode(final NodeIdentifier name) throws IOException {
98 tracker.startLeafNode(name);
99 startElement(name.getNodeType());
103 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
104 tracker.startLeafSetEntryNode(name);
105 startElement(name.getNodeType());
109 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
110 tracker.startLeafSet(name);
114 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
115 tracker.startLeafSet(name);
119 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
120 final SchemaNode schema = tracker.startContainerNode(name);
121 startElement(schema.getQName());
125 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
126 tracker.startChoiceNode(name);
130 public void startAugmentationNode(final AugmentationIdentifier identifier) {
131 tracker.startAugmentationNode(identifier);
135 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
136 final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
137 startElement(schema.getQName());
141 public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
142 tracker.startAnyxmlNode(name);
143 startElement(name.getNodeType());
147 public SchemaContext getSchemaContext() {
148 return streamUtils.getSchemaContext();
152 public void scalarValue(final Object value) throws IOException {
153 final Object current = tracker.getParent();
154 if (current instanceof TypedDataSchemaNode) {
155 writeValue(value, (SchemaNode) current);
156 } else if (current instanceof AnydataSchemaNode) {
159 throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
164 public void domSourceValue(final DOMSource value) throws IOException {
165 final Object current = tracker.getParent();
166 checkState(current instanceof AnyxmlSchemaNode, "Unexpected scala value %s with %s", value, current);
171 void startAnydata(final NodeIdentifier name) {
172 tracker.startAnydataNode(name);