2 * Copyright (c) 2015 Cisco Systems, Inc. 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 java.io.IOException;
11 import org.opendaylight.yangtools.yang.binding.BindingSerializer;
12 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
13 import org.opendaylight.yangtools.yang.binding.DataObject;
14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
15 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
18 * Serializer of Binding objects to Normalized Node which uses {@link BindingNormalizedNodeCache} to
19 * cache already serialized values.
22 * This serializer implements {@link BindingStreamEventWriter} along with {@link BindingSerializer}.
25 * {@link BindingSerializer} interface is used by generated implementations of
26 * {@link org.opendaylight.yangtools.yang.binding.DataObjectSerializer} to provide Binding object
27 * for inspection and to prevent streaming of already serialized object.
29 final class CachingNormalizedNodeSerializer extends ForwardingBindingStreamEventWriter implements
30 BindingSerializer<Object, DataObject> {
32 private final NormalizedNodeResult domResult;
33 private final NormalizedNodeWriterWithAddChild domWriter;
34 private final BindingToNormalizedStreamWriter delegate;
35 private final AbstractBindingNormalizedNodeCacheHolder cacheHolder;
37 CachingNormalizedNodeSerializer(final AbstractBindingNormalizedNodeCacheHolder cacheHolder,
38 final DataContainerCodecContext<?, ?> subtreeRoot) {
39 this.cacheHolder = cacheHolder;
40 this.domResult = new NormalizedNodeResult();
41 this.domWriter = new NormalizedNodeWriterWithAddChild(domResult);
42 this.delegate = BindingToNormalizedStreamWriter.create(subtreeRoot, domWriter);
46 protected BindingStreamEventWriter delegate() {
50 NormalizedNode<?, ?> build() {
51 return domResult.getResult();
55 * Serializes input if it is cached, returns null otherwise.
58 * If input is cached it uses {@link NormalizedNodeWriterWithAddChild#addChild(NormalizedNode)}
59 * to provide already serialized value to underlying NormalizedNodeWriter in order to reuse
60 * value instead of creating new one using Normalized Node stream APIs.
63 * Note that this optional is serialization of child node invoked from
64 * {@link org.opendaylight.yangtools.yang.binding.DataObjectSerializer}, which may opt-out from
65 * streaming of data when non-null result is returned.
68 public NormalizedNode<?, ?> serialize(final DataObject input) {
69 final BindingNormalizedNodeCache cachingSerializer = getCacheSerializer(input.implementedInterface());
70 if (cachingSerializer != null) {
71 final NormalizedNode<?, ?> domData = cachingSerializer.get(input);
72 domWriter.addChild(domData);
79 * Serializes supplied data using stream writer with child cache enabled or using cache directly
80 * if cache is avalaible also for supplied Codec node.
82 * @param cacheHolder Binding to Normalized Node Cache holder
83 * @param subtreeRoot Codec Node for provided data object
84 * @param data Data to be serialized
85 * @return Normalized Node representation of data.
87 static NormalizedNode<?, ?> serialize(final AbstractBindingNormalizedNodeCacheHolder cacheHolder,
88 final DataContainerCodecContext<?, ?> subtreeRoot, final DataObject data) {
89 final BindingNormalizedNodeCache cache = cacheHolder.getCachingSerializer(subtreeRoot);
91 return cache.get(data);
93 return serializeUsingStreamWriter(cacheHolder, subtreeRoot, data);
96 private BindingNormalizedNodeCache getCacheSerializer(final Class<? extends DataObject> type) {
97 if (cacheHolder.isCached(type)) {
98 final DataContainerCodecContext<?, ?> currentCtx = (DataContainerCodecContext<?, ?>) delegate.current();
99 if (type.equals(currentCtx.getBindingClass())) {
100 return cacheHolder.getCachingSerializer(currentCtx);
102 return cacheHolder.getCachingSerializer(currentCtx.streamChild(type));
108 * Serializes supplied data using stream writer with child cache enabled.
110 * @param cacheHolder Binding to Normalized Node Cache holder
111 * @param subtreeRoot Codec Node for provided data object
112 * @param data Data to be serialized
113 * @return Normalized Node representation of data.
115 static NormalizedNode<?, ?> serializeUsingStreamWriter(final AbstractBindingNormalizedNodeCacheHolder cacheHolder,
116 final DataContainerCodecContext<?, ?> subtreeRoot, final DataObject data) {
117 final CachingNormalizedNodeSerializer writer = new CachingNormalizedNodeSerializer(cacheHolder, subtreeRoot);
119 subtreeRoot.eventStreamSerializer().serialize(data, writer);
120 return writer.build();
121 } catch (final IOException e) {
122 throw new IllegalStateException(e);