2 * Copyright (c) 2013 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.java.api.generator
10 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getClassName
11 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getRootPackageName
12 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME
13 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODULE_INFO_CLASS_NAME
14 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODULE_INFO_QNAMEOF_METHOD_NAME
16 import com.google.common.base.Preconditions
17 import com.google.common.collect.ImmutableSet
18 import java.util.Comparator
19 import java.util.HashSet
20 import java.util.Optional
22 import java.util.TreeMap
23 import java.util.function.Function
24 import org.eclipse.xtend.lib.annotations.Accessors
25 import org.gaul.modernizer_maven_annotations.SuppressModernizer
26 import org.opendaylight.yangtools.yang.binding.YangModuleInfo
27 import org.opendaylight.yangtools.yang.common.Revision
28 import org.opendaylight.yangtools.yang.model.api.Module
29 import org.opendaylight.yangtools.yang.model.api.SchemaContext
32 * Template for {@link YangModuleInfo} implementation for a particular module. Aside from fulfilling that contract,
33 * this class provides a static {@code createQName(String)} method, which is used by co-generated code to initialize
37 class YangModuleInfoTemplate {
38 static val Comparator<Optional<Revision>> REVISION_COMPARATOR =
39 [ Optional<Revision> first, Optional<Revision> second | Revision.compare(first, second) ]
41 // These are always imported. Note we need to import even java.lang members, as there can be conflicting definitions
43 static val CORE_IMPORT_STR = '''
44 import com.google.common.collect.ImmutableSet;
45 import java.lang.Override;
46 import java.lang.String;
47 import org.eclipse.jdt.annotation.NonNull;
48 import org.opendaylight.yangtools.yang.binding.ResourceYangModuleInfo;
49 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
50 import org.opendaylight.yangtools.yang.common.QName;
52 static val EXT_IMPORT_STR = '''
53 import com.google.common.collect.ImmutableSet;
54 import java.lang.Override;
55 import java.lang.String;
56 import java.util.HashSet;
58 import org.eclipse.jdt.annotation.NonNull;
59 import org.opendaylight.yangtools.yang.binding.ResourceYangModuleInfo;
60 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
61 import org.opendaylight.yangtools.yang.common.QName;
66 val Function<Module, Optional<String>> moduleFilePathResolver
68 var importedTypes = CORE_IMPORT_STR
71 val String packageName
74 val String modelBindingProviderName
76 new(Module module, SchemaContext ctx, Function<Module, Optional<String>> moduleFilePathResolver) {
77 Preconditions.checkArgument(module !== null, "Module must not be null.")
80 this.moduleFilePathResolver = moduleFilePathResolver
81 packageName = module.QNameModule.rootPackageName;
82 modelBindingProviderName = '''«packageName».«MODEL_BINDING_PROVIDER_CLASS_NAME»'''
85 def String generate() {
86 val Set<Module> submodules = new HashSet
87 collectSubmodules(submodules, module)
90 public final class «MODULE_INFO_CLASS_NAME» extends ResourceYangModuleInfo {
91 «val rev = module.revision»
92 private static final @NonNull QName NAME = QName.create("«module.namespace.toString»", «IF rev.present»"«rev.get.toString»", «ENDIF»"«module.name»").intern();
93 private static final @NonNull YangModuleInfo INSTANCE = new «MODULE_INFO_CLASS_NAME»();
95 private final @NonNull ImmutableSet<YangModuleInfo> importedModules;
97 public static YangModuleInfo getInstance() {
101 public static @NonNull QName «MODULE_INFO_QNAMEOF_METHOD_NAME»(final String localName) {
102 return QName.create(NAME, localName).intern();
105 «classBody(module, MODULE_INFO_CLASS_NAME, submodules)»
109 package «packageName»;
117 def String generateModelProvider() '''
118 package «packageName»;
120 import java.lang.Override;
121 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
122 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
124 public final class «MODEL_BINDING_PROVIDER_CLASS_NAME» implements YangModelBindingProvider {
126 public YangModuleInfo getModuleInfo() {
127 return «MODULE_INFO_CLASS_NAME».getInstance();
132 private static def void collectSubmodules(Set<Module> dest, Module module) {
133 for (Module submodule : module.submodules) {
134 if (dest.add(submodule)) {
135 collectSubmodules(dest, submodule)
140 private def CharSequence classBody(Module m, String className, Set<Module> submodules) '''
141 private «className»() {
142 «IF !m.imports.empty || !submodules.empty»
144 Set<YangModuleInfo> set = new HashSet<>();
146 «IF !m.imports.empty»
147 «FOR imp : m.imports»
148 «val name = imp.moduleName»
149 «val rev = imp.revision»
151 «val Set<Module> modules = ctx.modules»
152 «val TreeMap<Optional<Revision>, Module> sorted = new TreeMap(REVISION_COMPARATOR)»
153 «FOR module : modules»
154 «IF module.name.equals(name)»
155 «sorted.put(module.revision, module)»
158 set.add(«sorted.lastEntry().value.QNameModule.rootPackageName».«MODULE_INFO_CLASS_NAME».getInstance());
160 set.add(«(ctx.findModule(name, rev).get.QNameModule).rootPackageName».«MODULE_INFO_CLASS_NAME».getInstance());
164 «FOR submodule : submodules»
165 set.add(«submodule.name.className»Info.getInstance());
167 «IF m.imports.empty && submodules.empty»
168 importedModules = ImmutableSet.of();
170 importedModules = ImmutableSet.copyOf(set);
175 public QName getName() {
180 protected String resourceName() {
181 return "«sourcePath(m)»";
185 public ImmutableSet<YangModuleInfo> getImportedModules() {
186 return importedModules;
188 «generateSubInfo(submodules)»
191 private def void extendImports() {
192 importedTypes = EXT_IMPORT_STR
195 private def sourcePath(Module module) {
196 val opt = moduleFilePathResolver.apply(module)
197 Preconditions.checkState(opt.isPresent, "Module %s does not have a file path", module)
201 private def generateSubInfo(Set<Module> submodules) '''
202 «FOR submodule : submodules»
203 «val className = submodule.name.className»
205 private static final class «className»Info extends ResourceYangModuleInfo {
206 «val rev = submodule.revision»
207 private final @NonNull QName NAME = QName.create("«submodule.namespace.toString»", «
208 IF rev.present»"«rev.get.toString»", «ENDIF»"«submodule.name»").intern();
209 private static final @NonNull YangModuleInfo INSTANCE = new «className»Info();
211 private final @NonNull ImmutableSet<YangModuleInfo> importedModules;
213 public static @NonNull YangModuleInfo getInstance() {
217 «classBody(submodule, className + "Info", ImmutableSet.of)»