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.checkState;
12 import static java.util.Objects.requireNonNull;
14 import java.io.IOException;
15 import javax.xml.stream.XMLStreamException;
16 import javax.xml.stream.XMLStreamWriter;
17 import javax.xml.transform.dom.DOMSource;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
21 import org.opendaylight.yangtools.yang.common.AnnotationName;
22 import org.opendaylight.yangtools.yang.common.QName;
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.util.NormalizedNodeStreamWriterStack;
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.ContainerLike;
30 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
31 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
35 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
38 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter
39 extends XMLStreamNormalizedNodeStreamWriter<TypedDataSchemaNode> {
40 private final NormalizedNodeStreamWriterStack tracker;
41 private final SchemaAwareXMLStreamWriterUtils streamUtils;
43 private SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer,
44 final EffectiveModelContext modelContext, final NormalizedNodeStreamWriterStack tracker,
45 final @Nullable PreferredPrefixes pref) {
47 this.tracker = requireNonNull(tracker);
48 streamUtils = new SchemaAwareXMLStreamWriterUtils(modelContext, pref);
51 SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer,
52 final EffectiveModelContext modelContext, final NormalizedNodeStreamWriterStack tracker,
53 final boolean modelPrefixes) {
54 this(writer, modelContext, tracker, modelPrefixes ? new PreferredPrefixes.Shared(modelContext) : null);
58 String encodeValue(final ValueWriter xmlWriter, final Object value, final TypedDataSchemaNode schemaNode)
59 throws XMLStreamException {
60 return streamUtils.encodeValue(xmlWriter, resolveType(schemaNode.getType()), value,
61 schemaNode.getQName().getModule());
65 String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
66 throws XMLStreamException {
67 final var optAnnotation = AnnotationSchemaNode.find(streamUtils.modelContext(), new AnnotationName(qname));
68 if (optAnnotation.isPresent()) {
69 return streamUtils.encodeValue(xmlWriter, resolveType(optAnnotation.orElseThrow().getType()), value,
73 if (qname.getRevision().isPresent()) {
74 throw new IllegalArgumentException("Failed to find bound annotation " + qname);
76 if (value instanceof String str) {
79 throw new IllegalArgumentException("Invalid non-string value " + value + " for unbound annotation " + qname);
83 void startList(final NodeIdentifier name) {
84 tracker.startList(name);
88 void startListItem(final PathArgument name) throws IOException {
89 tracker.startListItem(name);
90 startElement(name.getNodeType());
94 public void endNode() throws IOException {
95 final Object schema = tracker.endNode();
96 if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
97 // For lists, we only emit end element on the inner frame
98 final Object parent = tracker.getParent();
99 if (parent == schema) {
102 } else if (schema instanceof ContainerLike || schema instanceof LeafSchemaNode
103 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
109 public void startLeafNode(final NodeIdentifier name) throws IOException {
110 tracker.startLeafNode(name);
111 startElement(name.getNodeType());
115 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
116 tracker.startLeafSetEntryNode(name);
117 startElement(name.getNodeType());
121 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
122 tracker.startLeafSet(name);
126 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
127 tracker.startLeafSet(name);
131 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
132 tracker.startContainerNode(name);
133 startElement(name.getNodeType());
137 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
138 tracker.startChoiceNode(name);
142 public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
143 if (DOMSource.class.isAssignableFrom(objectModel)) {
144 tracker.startAnyxmlNode(name);
145 startElement(name.getNodeType());
152 public void scalarValue(final Object value) throws IOException {
153 final Object current = tracker.getParent();
154 if (current instanceof TypedDataSchemaNode typedSchema) {
155 writeValue(value, typedSchema);
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 value %s with %s", value, current);
171 void startAnydata(final NodeIdentifier name) {
172 tracker.startAnydataNode(name);
175 private @NonNull TypeDefinition<?> resolveType(final @NonNull TypeDefinition<?> type) throws XMLStreamException {
176 if (type instanceof LeafrefTypeDefinition leafref) {
178 return tracker.resolveLeafref(leafref);
179 } catch (IllegalArgumentException e) {
180 throw new XMLStreamException("Cannot resolve type " + type, e);