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 javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import javax.xml.transform.dom.DOMSource;
19 import org.eclipse.jdt.annotation.NonNull;
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.EffectiveModelContextProvider;
32 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
37 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
40 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter
41 extends XMLStreamNormalizedNodeStreamWriter<TypedDataSchemaNode> implements EffectiveModelContextProvider {
42 private final NormalizedNodeStreamWriterStack tracker;
43 private final SchemaAwareXMLStreamWriterUtils streamUtils;
45 SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final EffectiveModelContext context,
46 final NormalizedNodeStreamWriterStack tracker) {
48 this.tracker = requireNonNull(tracker);
49 streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
53 String encodeValue(final ValueWriter xmlWriter, final Object value, final TypedDataSchemaNode schemaNode)
54 throws XMLStreamException {
55 return streamUtils.encodeValue(xmlWriter, resolveType(schemaNode.getType()), value,
56 schemaNode.getQName().getModule());
60 String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
61 throws XMLStreamException {
62 final var optAnnotation = AnnotationSchemaNode.find(streamUtils.getEffectiveModelContext(),
63 new AnnotationName(qname));
64 if (optAnnotation.isPresent()) {
65 return streamUtils.encodeValue(xmlWriter, resolveType(optAnnotation.orElseThrow().getType()), value,
69 checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
70 checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
71 return (String) value;
75 void startList(final NodeIdentifier name) {
76 tracker.startList(name);
80 void startListItem(final PathArgument name) throws IOException {
81 tracker.startListItem(name);
82 startElement(name.getNodeType());
86 public void endNode() throws IOException {
87 final Object schema = tracker.endNode();
88 if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
89 // For lists, we only emit end element on the inner frame
90 final Object parent = tracker.getParent();
91 if (parent == schema) {
94 } else if (schema instanceof ContainerLike || schema instanceof LeafSchemaNode
95 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
101 public void startLeafNode(final NodeIdentifier name) throws IOException {
102 tracker.startLeafNode(name);
103 startElement(name.getNodeType());
107 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
108 tracker.startLeafSetEntryNode(name);
109 startElement(name.getNodeType());
113 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
114 tracker.startLeafSet(name);
118 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
119 tracker.startLeafSet(name);
123 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
124 final SchemaNode schema = tracker.startContainerNode(name);
125 startElement(schema.getQName());
129 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
130 tracker.startChoiceNode(name);
134 public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
135 if (DOMSource.class.isAssignableFrom(objectModel)) {
136 tracker.startAnyxmlNode(name);
137 startElement(name.getNodeType());
144 public EffectiveModelContext getEffectiveModelContext() {
145 return streamUtils.getEffectiveModelContext();
149 public void scalarValue(final Object value) throws IOException {
150 final Object current = tracker.getParent();
151 if (current instanceof TypedDataSchemaNode) {
152 writeValue(value, (TypedDataSchemaNode) current);
153 } else if (current instanceof AnydataSchemaNode) {
156 throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
161 public void domSourceValue(final DOMSource value) throws IOException {
162 final Object current = tracker.getParent();
163 checkState(current instanceof AnyxmlSchemaNode, "Unexpected value %s with %s", value, current);
168 void startAnydata(final NodeIdentifier name) {
169 tracker.startAnydataNode(name);
172 private @NonNull TypeDefinition<?> resolveType(final @NonNull TypeDefinition<?> type) throws XMLStreamException {
173 if (type instanceof LeafrefTypeDefinition) {
175 return tracker.resolveLeafref((LeafrefTypeDefinition) type);
176 } catch (IllegalArgumentException e) {
177 throw new XMLStreamException("Cannot resolve type " + type, e);