2 * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Verify.verify;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableClassToInstanceMap;
15 import java.io.IOException;
16 import java.lang.reflect.InvocationHandler;
17 import java.lang.reflect.Proxy;
18 import java.util.Collection;
19 import java.util.List;
21 import java.util.Map.Entry;
22 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
23 import org.opendaylight.mdsal.binding.dom.codec.util.AugmentationReader;
24 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
25 import org.opendaylight.yangtools.yang.binding.Augmentable;
26 import org.opendaylight.yangtools.yang.binding.Augmentation;
27 import org.opendaylight.yangtools.yang.binding.DataContainer;
28 import org.opendaylight.yangtools.yang.binding.DataObject;
29 import org.opendaylight.yangtools.yang.binding.Identifiable;
30 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
35 * Base superclass for all concrete streamers, that is objects which are able to turn a concrete DataObject into a
38 * @param <T> DataObject type
41 public abstract class DataObjectStreamer<T extends DataObject> implements DataObjectSerializerImplementation {
42 private static final Logger LOG = LoggerFactory.getLogger(DataObjectStreamer.class);
44 protected DataObjectStreamer() {
48 protected static final void streamAnydata(final BindingStreamEventWriter writer, final String localName,
49 final Object value) throws IOException {
50 if (value != null && writer instanceof AnydataBindingStreamWriter) {
51 verify(value instanceof OpaqueObject, "Unexpected data %s", value);
52 ((AnydataBindingStreamWriter) writer).anydataNode(localName, (OpaqueObject<?>) value);
56 protected static final void streamAnyxml(final BindingStreamEventWriter writer, final String localName,
57 final Object value) throws IOException {
59 writer.anyxmlNode(localName, value);
63 protected static final void streamAugmentations(final DataObjectSerializerRegistry registry,
64 final BindingStreamEventWriter writer, final Augmentable<?> obj) throws IOException {
65 final Map<Class<? extends Augmentation<?>>, Augmentation<?>> augmentations;
66 if (registry instanceof AugmentationReader) {
67 augmentations = ((AugmentationReader) registry).getAugmentations(obj);
68 } else if (Proxy.isProxyClass(obj.getClass())) {
69 augmentations = getFromProxy(obj);
71 augmentations = BindingReflections.getAugmentations(obj);
73 for (final Entry<Class<? extends Augmentation<?>>, Augmentation<?>> aug : augmentations.entrySet()) {
74 emitAugmentation(aug.getKey(), aug.getValue(), writer, registry);
78 private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getFromProxy(final Augmentable<?> obj) {
79 final InvocationHandler proxy = Proxy.getInvocationHandler(obj);
80 if (proxy instanceof AugmentationReader) {
81 return ((AugmentationReader) proxy).getAugmentations(obj);
83 return ImmutableClassToInstanceMap.of();
86 protected static final <C extends DataContainer> void streamChoice(final Class<C> choiceClass,
87 final DataObjectSerializerRegistry registry, final BindingStreamEventWriter writer, final C value)
90 final Class<? extends DataContainer> caseClass = value.implementedInterface();
91 writer.startChoiceNode(choiceClass, BindingStreamEventWriter.UNKNOWN_SIZE);
92 final DataObjectSerializer caseStreamer = registry.getSerializer(caseClass.asSubclass(DataObject.class));
93 if (caseStreamer != null) {
94 if (tryCache(writer, (DataObject) value)) {
95 caseStreamer.serialize((DataObject) value, writer);
98 LOG.warn("No serializer for case {} is available in registry {}", caseClass, registry);
105 protected static final <C extends DataObject> void streamContainer(final DataObjectStreamer<C> childStreamer,
106 final DataObjectSerializerRegistry registry, final BindingStreamEventWriter writer, final C value)
108 if (value != null && tryCache(writer, value)) {
109 childStreamer.serialize(registry, value, writer);
113 protected static final void streamLeaf(final BindingStreamEventWriter writer, final String localName,
114 final Object value) throws IOException {
116 writer.leafNode(localName, value);
120 protected static final void streamLeafList(final BindingStreamEventWriter writer, final String localName,
121 final List<?> value) throws IOException {
123 writer.startLeafSet(localName, value.size());
124 commonStreamLeafset(writer, value);
128 protected static final void streamOrderedLeafList(final BindingStreamEventWriter writer,
129 final String localName, final List<?> value) throws IOException {
131 writer.startOrderedLeafSet(localName, value.size());
132 commonStreamLeafset(writer, value);
136 protected static final <E extends DataObject> void streamList(final Class<E> childClass,
137 final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
138 final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
139 final int size = nullSize(value);
141 writer.startUnkeyedList(childClass, size);
142 commonStreamList(registry, writer, childStreamer, value);
146 protected static final <E extends DataObject & Identifiable<?>> void streamMap(final Class<E> childClass,
147 final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
148 final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
149 final int size = nullSize(value);
151 writer.startMapNode(childClass, size);
152 commonStreamList(registry, writer, childStreamer, value);
156 protected static final <E extends DataObject & Identifiable<?>> void streamOrderedMap(final Class<E> childClass,
157 final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
158 final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
159 final int size = nullSize(value);
161 writer.startOrderedMapNode(childClass, size);
162 commonStreamList(registry, writer, childStreamer, value);
166 private static <E extends DataObject> void commonStreamList(final DataObjectSerializerRegistry registry,
167 final BindingStreamEventWriter writer, final DataObjectStreamer<E> childStreamer,
168 final Collection<? extends E> value) throws IOException {
170 for (E entry : value) {
171 if (tryCache(writer, entry)) {
172 childStreamer.serialize(registry, entry, writer);
178 private static void commonStreamLeafset(final BindingStreamEventWriter writer, final List<?> value)
180 for (Object entry : value) {
181 writer.leafSetEntryNode(entry);
186 @SuppressWarnings("rawtypes")
187 private static void emitAugmentation(final Class type, final Augmentation<?> value,
188 final BindingStreamEventWriter writer, final DataObjectSerializerRegistry registry) throws IOException {
190 * Binding Specification allowed to insert augmentation with null for
191 * value, which effectively could be used to remove augmentation
192 * from builder / DTO.
195 checkArgument(value instanceof DataObject);
196 @SuppressWarnings("unchecked")
197 final DataObjectSerializer serializer = registry.getSerializer(type);
198 if (serializer != null) {
199 serializer.serialize((DataObject) value, writer);
201 LOG.warn("DataObjectSerializer is not present for {} in registry {}", type, registry);
206 @SuppressWarnings("unchecked")
207 private static <T extends DataObject> boolean tryCache(final BindingStreamEventWriter writer, final T value) {
208 return writer instanceof BindingSerializer ? ((BindingSerializer<?, T>) writer).serialize(value) == null : true;
211 private static int nullSize(final List<?> list) {
212 return list == null ? 0 : list.size();