2 * Copyright (c) 2014 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 com.google.common.collect.ImmutableCollection;
11 import com.google.common.collect.ImmutableSet;
12 import java.io.IOException;
13 import java.util.List;
14 import java.util.Optional;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.eclipse.jdt.annotation.Nullable;
17 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
18 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
21 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.common.QNameModule;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
27 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
28 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
29 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
31 abstract class DataContainerCodecContext<D extends DataObject, T extends WithStatus> extends NodeCodecContext<D> {
33 private final DataContainerCodecPrototype<T> prototype;
34 private volatile DataObjectSerializer eventStreamSerializer;
36 protected DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
37 this.prototype = prototype;
41 public final T getSchema() {
42 return prototype.getSchema();
46 public final ChildAddressabilitySummary getChildAddressabilitySummary() {
47 return prototype.getChildAddressabilitySummary();
50 protected final QNameModule namespace() {
51 return prototype.getNamespace();
54 protected final CodecContextFactory factory() {
55 return prototype.getFactory();
59 protected YangInstanceIdentifier.PathArgument getDomPathArgument() {
60 return prototype.getYangArg();
64 * Returns nested node context using supplied YANG Instance Identifier.
66 * @param arg Yang Instance Identifier Argument
67 * @return Context of child
68 * @throws IllegalArgumentException If supplied argument does not represent valid child.
71 public abstract NodeCodecContext<?> yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
74 * Returns nested node context using supplied Binding Instance Identifier
75 * and adds YANG instance identifiers to supplied list.
77 * @param arg Binding Instance Identifier Argument
78 * @return Context of child or null if supplied {@code arg} does not represent valid child.
79 * @throws IllegalArgumentException If supplied argument does not represent valid child.
82 public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final PathArgument arg,
83 final List<YangInstanceIdentifier.PathArgument> builder) {
84 final DataContainerCodecContext<?,?> child = streamChild(arg.getType());
85 if (builder != null) {
86 child.addYangPathArgument(arg,builder);
92 * Returns deserialized Binding Path Argument from YANG instance identifier.
94 protected PathArgument getBindingPathArgument(final YangInstanceIdentifier.PathArgument domArg) {
98 protected final PathArgument bindingArg() {
99 return prototype.getBindingArg();
102 @SuppressWarnings("unchecked")
104 public final Class<D> getBindingClass() {
105 return Class.class.cast(prototype.getBindingClass());
109 public abstract <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
112 * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
113 * must issue getChild(ChoiceClass).getChild(CaseClass).
115 * @param childClass child class
116 * @return Context of child or Optional.empty is supplied class is not applicable in context.
119 public abstract <C extends DataObject> Optional<DataContainerCodecContext<C,?>> possibleStreamChild(
120 Class<C> childClass);
123 public String toString() {
124 return getClass().getSimpleName() + " [" + prototype.getBindingClass() + "]";
128 public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
129 final ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) {
130 if (cacheSpecifier.isEmpty()) {
131 return new NonCachingCodec<>(this);
133 return new CachingNormalizedNodeCodec<>(this, ImmutableSet.copyOf(cacheSpecifier));
136 BindingStreamEventWriter createWriter(final NormalizedNodeStreamWriter domWriter) {
137 return BindingToNormalizedStreamWriter.create(this, domWriter);
140 protected final <V> @NonNull V childNonNull(final @Nullable V nullable,
141 final YangInstanceIdentifier.PathArgument child, final String message, final Object... args) {
142 if (nullable != null) {
145 MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
146 throw IncorrectNestingException.create(message, args);
149 protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final QName child, final String message,
150 final Object... args) {
151 if (nullable != null) {
154 MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
155 throw IncorrectNestingException.create(message, args);
158 protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final Class<?> childClass,
159 final String message, final Object... args) {
160 if (nullable != null) {
163 MissingSchemaForClassException.check(factory().getRuntimeContext(), childClass);
164 MissingClassInLoadingStrategyException.check(factory().getRuntimeContext().getStrategy(), childClass);
165 throw IncorrectNestingException.create(message, args);
168 DataObjectSerializer eventStreamSerializer() {
169 if (eventStreamSerializer == null) {
170 eventStreamSerializer = factory().getEventStreamSerializer(getBindingClass());
172 return eventStreamSerializer;
176 public NormalizedNode<?, ?> serialize(final D data) {
177 final NormalizedNodeResult result = new NormalizedNodeResult();
178 // We create DOM stream writer which produces normalized nodes
179 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
180 writeAsNormalizedNode(data, domWriter);
181 return result.getResult();
185 public void writeAsNormalizedNode(final D data, final NormalizedNodeStreamWriter writer) {
187 eventStreamSerializer().serialize(data, createWriter(writer));
188 } catch (final IOException e) {
189 throw new IllegalStateException("Failed to serialize Binding DTO",e);