2 * Copyright (c) 2014, 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
9 package org.opendaylight.yangtools.binding.data.codec.gen.impl;
11 import com.google.common.base.Preconditions;
12 import java.util.HashMap;
14 import org.opendaylight.yangtools.binding.data.codec.util.ChoiceDispatchSerializer;
15 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
16 import org.opendaylight.yangtools.sal.binding.model.api.MethodSignature;
17 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
18 import org.opendaylight.yangtools.sal.binding.model.api.Type;
19 import org.opendaylight.yangtools.yang.binding.BindingMapping;
20 import org.opendaylight.yangtools.yang.binding.BindingSerializer;
21 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
22 import org.opendaylight.yangtools.yang.binding.DataObject;
23 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
24 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
25 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
29 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
34 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
35 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 abstract class DataNodeContainerSerializerSource extends DataObjectSerializerSource {
41 private static final Logger LOG = LoggerFactory.getLogger(DataNodeContainerSerializerSource.class);
43 protected static final String INPUT = "_input";
44 private static final String CHOICE_PREFIX = "CHOICE_";
46 protected final DataNodeContainer schemaNode;
47 private final GeneratedType dtoType;
49 DataNodeContainerSerializerSource(final AbstractGenerator generator, final GeneratedType type, final DataNodeContainer node) {
51 this.dtoType = Preconditions.checkNotNull(type);
52 this.schemaNode = Preconditions.checkNotNull(node);
56 * Return the character sequence which should be used for start event.
58 * @return Start event character sequence
60 protected abstract CharSequence emitStartEvent();
63 protected CharSequence getSerializerBody() {
64 final StringBuilder b = new StringBuilder();
66 b.append(statement(assign(DataObjectSerializerRegistry.class.getName(), REGISTRY, "$1")));
67 b.append(statement(assign(dtoType.getFullyQualifiedName(), INPUT,
68 cast(dtoType.getFullyQualifiedName(), "$2"))));
69 b.append(statement(assign(BindingStreamEventWriter.class.getName(), STREAM, cast(BindingStreamEventWriter.class.getName(), "$3"))));
70 b.append(statement(assign(BindingSerializer.class.getName(), SERIALIZER, null)));
73 b.append(" instanceof ");
74 b.append(BindingSerializer.class.getName());
76 b.append(statement(assign(SERIALIZER, cast(BindingSerializer.class.getName(), STREAM))));
78 b.append(statement(emitStartEvent()));
82 b.append(statement(endNode()));
83 b.append(statement("return null"));
89 * Allows for customization of emitting code, which is processed after
90 * normal DataNodeContainer body. Ideal for augmentations or others.
92 protected void emitAfterBody(final StringBuilder b) {
96 private static Map<String, Type> collectAllProperties(final GeneratedType type, final Map<String, Type> hashMap) {
97 for (final MethodSignature definition : type.getMethodDefinitions()) {
98 hashMap.put(definition.getName(), definition.getReturnType());
100 for (final Type parent : type.getImplements()) {
101 if (parent instanceof GeneratedType) {
102 collectAllProperties((GeneratedType) parent, hashMap);
108 private static String getGetterName(final DataSchemaNode node) {
109 final TypeDefinition<?> type ;
110 if (node instanceof LeafSchemaNode) {
111 type = ((LeafSchemaNode) node).getType();
112 } else if(node instanceof LeafListSchemaNode) {
113 type = ((LeafListSchemaNode) node).getType();
117 String prefix = "get";
119 TypeDefinition<?> rootType = type;
120 while (rootType.getBaseType() != null) {
121 rootType = rootType.getBaseType();
123 if(rootType instanceof BooleanTypeDefinition || rootType instanceof EmptyTypeDefinition) {
128 return prefix + BindingMapping.getClassName(node.getQName().getLocalName());
131 private void emitBody(final StringBuilder b) {
132 final Map<String, Type> getterToType = collectAllProperties(dtoType, new HashMap<String, Type>());
133 for (final DataSchemaNode schemaChild : schemaNode.getChildNodes()) {
134 if (!schemaChild.isAugmenting()) {
135 final String getter = getGetterName(schemaChild);
136 final Type childType = getterToType.get(getter);
137 if (childType == null) {
138 // FIXME AnyXml nodes are ignored, since their type cannot be found in generated bindnig
139 // Bug-706 https://bugs.opendaylight.org/show_bug.cgi?id=706
140 if (schemaChild instanceof AnyXmlSchemaNode) {
141 LOG.warn("Node {} will be ignored. AnyXml is not yet supported from binding aware code." +
142 "Binding Independent code can be used to serialize anyXml nodes.", schemaChild.getPath());
145 throw new IllegalStateException(
146 String.format("Unable to find type for child node %s. Expected child nodes: %s",
147 schemaChild.getPath(), getterToType));
150 emitChild(b, getter, childType, schemaChild);
155 private void emitChild(final StringBuilder b, final String getterName, final Type childType,
156 final DataSchemaNode schemaChild) {
157 b.append(statement(assign(childType, getterName, cast(childType, invoke(INPUT, getterName)))));
159 b.append("if (").append(getterName).append(" != null) {\n");
160 emitChildInner(b, getterName, childType, schemaChild);
164 private void emitChildInner(final StringBuilder b, final String getterName, final Type childType,
165 final DataSchemaNode child) {
166 if (child instanceof LeafSchemaNode) {
167 b.append(statement(leafNode(child.getQName().getLocalName(), getterName)));
168 } else if (child instanceof AnyXmlSchemaNode) {
169 b.append(statement(anyxmlNode(child.getQName().getLocalName(), getterName)));
170 } else if (child instanceof LeafListSchemaNode) {
171 b.append(statement(startLeafSet(child.getQName().getLocalName(),invoke(getterName, "size"))));
172 final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
173 b.append(forEach(getterName, valueType, statement(leafSetEntryNode(CURRENT))));
174 b.append(statement(endNode()));
175 } else if (child instanceof ListSchemaNode) {
176 final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
177 final ListSchemaNode casted = (ListSchemaNode) child;
178 emitList(b, getterName, valueType, casted);
179 } else if (child instanceof ContainerSchemaNode) {
180 b.append(tryToUseCacheElse(getterName,statement(staticInvokeEmitter(childType, getterName))));
181 } else if (child instanceof ChoiceSchemaNode) {
182 final String propertyName = CHOICE_PREFIX + childType.getName();
183 staticConstant(propertyName, DataObjectSerializerImplementation.class, ChoiceDispatchSerializer.from(loadClass(childType)));
184 b.append(tryToUseCacheElse(getterName,statement(invoke(propertyName, StreamWriterGenerator.SERIALIZE_METHOD_NAME, REGISTRY, cast(DataObject.class.getName(),getterName), STREAM))));
188 private StringBuilder tryToUseCacheElse(final String getterName, final CharSequence statement) {
189 final StringBuilder b = new StringBuilder();
192 b.append(SERIALIZER).append("== null || ");
193 b.append(invoke(SERIALIZER, "serialize", getterName)).append("== null");
200 private void emitList(final StringBuilder b, final String getterName, final Type valueType,
201 final ListSchemaNode child) {
202 final CharSequence startEvent;
204 b.append(statement(assign("int", "_count", invoke(getterName, "size"))));
205 if (child.getKeyDefinition().isEmpty()) {
206 startEvent = startUnkeyedList(classReference(valueType), "_count");
207 } else if (child.isUserOrdered()) {
208 startEvent = startOrderedMapNode(classReference(valueType), "_count");
210 startEvent = startMapNode(classReference(valueType), "_count");
212 b.append(statement(startEvent));
213 b.append(forEach(getterName, valueType, tryToUseCacheElse(CURRENT,statement(staticInvokeEmitter(valueType, CURRENT)))));
214 b.append(statement(endNode()));