code-generator/binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/generator/impl/BindingGeneratorImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.sal.binding.generator.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkNotNull;
  12 import static com.google.common.base.Preconditions.checkState;
  13 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.computeDefaultSUID;
  14 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
  15 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.parseToValidParamName;
  16 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_OBJECT;
  17 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_ROOT;
  18 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIABLE;
  19 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIER;
  20 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.NOTIFICATION;
  21 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.augmentable;
  22 import static org.opendaylight.yangtools.binding.generator.util.Types.BOOLEAN;
  23 import static org.opendaylight.yangtools.binding.generator.util.Types.FUTURE;
  24 import static org.opendaylight.yangtools.binding.generator.util.Types.VOID;
  25 import static org.opendaylight.yangtools.binding.generator.util.Types.typeForClass;
  26 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
  27 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findNodeInSchemaContext;
  28 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
  29
  30 import com.google.common.base.Splitter;
  31 import com.google.common.collect.Iterables;
  32 import com.google.common.collect.Sets;
  33 import java.util.ArrayList;
  34 import java.util.Collection;
  35 import java.util.Collections;
  36 import java.util.HashMap;
  37 import java.util.Iterator;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.Set;
  41 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
  42 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
  43 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
  44 import org.opendaylight.yangtools.binding.generator.util.Types;
  45 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
  46 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
  47 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
  48 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
  49 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
  50 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
  51 import org.opendaylight.yangtools.sal.binding.model.api.Constant;
  52 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
  53 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
  54 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
  55 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
  56 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  57 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder;
  58 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
  59 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
  60 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
  61 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
  62 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  63 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
  64 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
  65 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
  66 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  67 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  68 import org.opendaylight.yangtools.yang.binding.DataContainer;
  69 import org.opendaylight.yangtools.yang.binding.RpcService;
  70 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
  71 import org.opendaylight.yangtools.yang.common.QName;
  72 import org.opendaylight.yangtools.yang.common.RpcResult;
  73 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  74 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  75 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  76 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  77 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  78 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  79 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  80 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  81 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  82 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  83 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  84 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  85 import org.opendaylight.yangtools.yang.model.api.Module;
  86 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  87 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  88 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  89 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  90 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  91 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  92 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  93 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  94 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  95 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  96 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  97 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  98 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
  99 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
 100 import org.opendaylight.yangtools.yang.model.util.UnionType;
 101 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
 102 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
 103 import org.slf4j.Logger;
 104 import org.slf4j.LoggerFactory;
 105
 106 public class BindingGeneratorImpl implements BindingGenerator {
 107     private static final Logger LOG = LoggerFactory.getLogger(BindingGeneratorImpl.class);
 108
 109     private final Map<Module, ModuleContext> genCtx = new HashMap<>();
 110
 111     /**
 112      * Outer key represents the package name. Outer value represents map of all
 113      * builders in the same package. Inner key represents the schema node name
 114      * (in JAVA class/interface name format). Inner value represents instance of
 115      * builder for schema node specified in key part.
 116      */
 117     private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
 118
 119     /**
 120      * Provide methods for converting YANG types to JAVA types.
 121      */
 122     private TypeProvider typeProvider;
 123
 124     /**
 125      * Holds reference to schema context to resolve data of augmented element
 126      * when creating augmentation builder
 127      */
 128     private SchemaContext schemaContext;
 129
 130     /**
 131      * Constant with the concrete name of namespace.
 132      */
 133     private final static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
 134
 135     /**
 136      * Constant with the concrete name of identifier.
 137      */
 138     private final static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
 139
 140     private final char NEW_LINE = '\n';
 141
 142     private final char TAB = '\t';
 143
 144     /**
 145      * Resolves generated types from <code>context</code> schema nodes of all
 146      * modules.
 147      *
 148      * Generated types are created for modules, groupings, types, containers,
 149      * lists, choices, augments, rpcs, notification, identities.
 150      *
 151      * @param context
 152      *            schema context which contains data about all schema nodes
 153      *            saved in modules
 154      * @return list of types (usually <code>GeneratedType</code>
 155      *         <code>GeneratedTransferObject</code>which are generated from
 156      *         <code>context</code> data.
 157      * @throws IllegalArgumentException
 158      *             if arg <code>context</code> is null
 159      * @throws IllegalStateException
 160      *             if <code>context</code> contain no modules
 161      */
 162     @Override
 163     public List<Type> generateTypes(final SchemaContext context) {
 164         checkArgument(context != null, "Schema Context reference cannot be NULL.");
 165         checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
 166         schemaContext = context;
 167         typeProvider = new TypeProviderImpl(context);
 168         final Set<Module> modules = context.getModules();
 169         return generateTypes(context, modules);
 170     }
 171
 172     /**
 173      * Resolves generated types from <code>context</code> schema nodes only for
 174      * modules specified in <code>modules</code>
 175      *
 176      * Generated types are created for modules, groupings, types, containers,
 177      * lists, choices, augments, rpcs, notification, identities.
 178      *
 179      * @param context
 180      *            schema context which contains data about all schema nodes
 181      *            saved in modules
 182      * @param modules
 183      *            set of modules for which schema nodes should be generated
 184      *            types
 185      * @return list of types (usually <code>GeneratedType</code> or
 186      *         <code>GeneratedTransferObject</code>) which:
 187      *         <ul>
 188      *         <li>are generated from <code>context</code> schema nodes and</li>
 189      *         <li>are also part of some of the module in <code>modules</code>
 190      *         set</li>.
 191      *         </ul>
 192      * @throws IllegalArgumentException
 193      *             <ul>
 194      *             <li>if arg <code>context</code> is null or</li>
 195      *             <li>if arg <code>modules</code> is null</li>
 196      *             </ul>
 197      * @throws IllegalStateException
 198      *             if <code>context</code> contain no modules
 199      */
 200     @Override
 201     public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
 202         checkArgument(context != null, "Schema Context reference cannot be NULL.");
 203         checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
 204         checkArgument(modules != null, "Set of Modules cannot be NULL.");
 205
 206         schemaContext = context;
 207         typeProvider = new TypeProviderImpl(context);
 208         Module[] modulesArray = new Module[context.getModules().size()];
 209         context.getModules().toArray(modulesArray);
 210         final List<Module> contextModules = ModuleDependencySort.sort(modulesArray);
 211         genTypeBuilders = new HashMap<>();
 212
 213         for (Module contextModule : contextModules) {
 214             moduleToGenTypes(contextModule, context);
 215         }
 216         for (Module contextModule : contextModules) {
 217             allAugmentsToGenTypes(contextModule);
 218         }
 219
 220         final List<Type> filteredGenTypes = new ArrayList<>();
 221         for (Module m : modules) {
 222             final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m);
 223             filteredGenTypes.addAll(ctx.getGeneratedTypes());
 224             final Set<Type> additionalTypes = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(m);
 225             if (additionalTypes != null) {
 226                 filteredGenTypes.addAll(additionalTypes);
 227             }
 228         }
 229
 230         return filteredGenTypes;
 231     }
 232
 233     private void moduleToGenTypes(final Module m, final SchemaContext context) {
 234         genCtx.put(m, new ModuleContext());
 235         allTypeDefinitionsToGenTypes(m);
 236         groupingsToGenTypes(m, m.getGroupings());
 237         rpcMethodsToGenType(m);
 238         allIdentitiesToGenTypes(m, context);
 239         notificationsToGenType(m);
 240
 241         if (!m.getChildNodes().isEmpty()) {
 242             final GeneratedTypeBuilder moduleType = moduleToDataType(m);
 243             genCtx.get(m).addModuleNode(moduleType);
 244             final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
 245             resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.getChildNodes());
 246         }
 247     }
 248
 249     /**
 250      * Converts all extended type definitions of module to the list of
 251      * <code>Type</code> objects.
 252      *
 253      * @param module
 254      *            module from which is obtained set of type definitions
 255      * @throws IllegalArgumentException
 256      *             <ul>
 257      *             <li>if module is null</li>
 258      *             <li>if name of module is null</li>
 259      *             </ul>
 260      * @throws IllegalStateException
 261      *             if set of type definitions from module is null
 262      */
 263     private void allTypeDefinitionsToGenTypes(final Module module) {
 264         checkArgument(module != null, "Module reference cannot be NULL.");
 265         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 266         final DataNodeIterator it = new DataNodeIterator(module);
 267         final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
 268         checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
 269
 270         for (TypeDefinition<?> typedef : typeDefinitions) {
 271             if (typedef != null) {
 272                 final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
 273                         typedef);
 274                 if (type != null) {
 275                     genCtx.get(module).addTypedefType(typedef.getPath(), type);
 276                 }
 277             }
 278         }
 279     }
 280
 281     private GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
 282             final GeneratedTypeBuilder childOf, final DataSchemaNode node) {
 283         if (node.isAugmenting() || node.isAddedByUses()) {
 284             return null;
 285         }
 286         final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
 287         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf);
 288         genType.addComment(node.getDescription());
 289         genType.setDescription(createDescription(node, genType.getFullyQualifiedName()));
 290         genType.setModuleName(module.getName());
 291         genType.setReference(node.getReference());
 292         genType.setSchemaPath(node.getPath().getPathFromRoot());
 293         if (node instanceof DataNodeContainer) {
 294             genCtx.get(module).addChildNodeType(node, genType);
 295             groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings());
 296             processUsesAugments((DataNodeContainer) node, module);
 297         }
 298         return genType;
 299     }
 300
 301     private void containerToGenType(final Module module, final String basePackageName,
 302             final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node) {
 303         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
 304         if (genType != null) {
 305             constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType);
 306             resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes());
 307         }
 308     }
 309
 310     private void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder parent,
 311             final GeneratedTypeBuilder childOf, final ListSchemaNode node) {
 312         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
 313         if (genType != null) {
 314             constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), Types.listTypeFor(genType));
 315
 316             final List<String> listKeys = listKeys(node);
 317             final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
 318             final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
 319             if (genTOBuilder != null) {
 320                 final Type identifierMarker = Types.parameterizedTypeFor(IDENTIFIER, genType);
 321                 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
 322                 genTOBuilder.addImplementsType(identifierMarker);
 323                 genType.addImplementsType(identifiableMarker);
 324             }
 325
 326             for (DataSchemaNode schemaNode : node.getChildNodes()) {
 327                 if (!schemaNode.isAugmenting()) {
 328                     addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
 329                 }
 330             }
 331
 332             // serialVersionUID
 333             if (genTOBuilder != null) {
 334                 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
 335                 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
 336                 genTOBuilder.setSUID(prop);
 337             }
 338
 339             typeBuildersToGenTypes(module, genType, genTOBuilder);
 340         }
 341     }
 342
 343     private void processUsesAugments(final DataNodeContainer node, final Module module) {
 344         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 345         for (UsesNode usesNode : node.getUses()) {
 346             for (AugmentationSchema augment : usesNode.getAugmentations()) {
 347                 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
 348                 processUsesAugments(augment, module);
 349             }
 350         }
 351     }
 352
 353     /**
 354      * Converts all <b>augmentation</b> of the module to the list
 355      * <code>Type</code> objects.
 356      *
 357      * @param module
 358      *            module from which is obtained list of all augmentation objects
 359      *            to iterate over them
 360      * @throws IllegalArgumentException
 361      *             <ul>
 362      *             <li>if the module is null</li>
 363      *             <li>if the name of module is null</li>
 364      *             </ul>
 365      * @throws IllegalStateException
 366      *             if set of augmentations from module is null
 367      */
 368     private void allAugmentsToGenTypes(final Module module) {
 369         checkArgument(module != null, "Module reference cannot be NULL.");
 370         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 371         checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
 372
 373         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 374         final List<AugmentationSchema> augmentations = resolveAugmentations(module);
 375         for (AugmentationSchema augment : augmentations) {
 376             augmentationToGenTypes(basePackageName, augment, module);
 377         }
 378     }
 379
 380     /**
 381      * Returns list of <code>AugmentationSchema</code> objects. The objects are
 382      * sorted according to the length of their target path from the shortest to
 383      * the longest.
 384      *
 385      * @param module
 386      *            module from which is obtained list of all augmentation objects
 387      * @return list of sorted <code>AugmentationSchema</code> objects obtained
 388      *         from <code>module</code>
 389      * @throws IllegalArgumentException
 390      *             if module is null
 391      * @throws IllegalStateException
 392      *             if set of module augmentations is null
 393      */
 394     private List<AugmentationSchema> resolveAugmentations(final Module module) {
 395         checkArgument(module != null, "Module reference cannot be NULL.");
 396         checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
 397
 398         final Set<AugmentationSchema> augmentations = module.getAugmentations();
 399         List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
 400         Collections.sort(sortedAugmentations, Comparators.AUGMENT_COMP);
 401
 402         return sortedAugmentations;
 403     }
 404
 405     /**
 406      * Create GeneratedTypeBuilder object from module argument.
 407      *
 408      * @param module
 409      *            Module object from which builder will be created
 410      * @return <code>GeneratedTypeBuilder</code> which is internal
 411      *         representation of the module
 412      * @throws IllegalArgumentException
 413      *             if module is null
 414      */
 415     private GeneratedTypeBuilder moduleToDataType(final Module module) {
 416         checkArgument(module != null, "Module reference cannot be NULL.");
 417
 418         final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
 419         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
 420         moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
 421         moduleDataTypeBuilder.addComment(module.getDescription());
 422         moduleDataTypeBuilder.setDescription(createDescription(module));
 423         moduleDataTypeBuilder.setReference(module.getReference());
 424         return moduleDataTypeBuilder;
 425     }
 426
 427     /**
 428      * Converts all <b>rpcs</b> inputs and outputs substatements of the module
 429      * to the list of <code>Type</code> objects. In addition are to containers
 430      * and lists which belong to input or output also part of returning list.
 431      *
 432      * @param module
 433      *            module from which is obtained set of all rpc objects to
 434      *            iterate over them
 435      * @throws IllegalArgumentException
 436      *             <ul>
 437      *             <li>if the module is null</li>
 438      *             <li>if the name of module is null</li>
 439      *             </ul>
 440      * @throws IllegalStateException
 441      *             if set of rpcs from module is null
 442      */
 443     private void rpcMethodsToGenType(final Module module) {
 444         checkArgument(module != null, "Module reference cannot be NULL.");
 445         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 446         final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
 447         checkState(rpcDefinitions != null, "Set of rpcs from module " + module.getName() + " cannot be NULL.");
 448         if (rpcDefinitions.isEmpty()) {
 449             return;
 450         }
 451
 452         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 453         final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");
 454         interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));
 455         interfaceBuilder.setDescription(createDescription(rpcDefinitions, module.getName(), module.getModuleSourcePath()));
 456
 457         for (RpcDefinition rpc : rpcDefinitions) {
 458             if (rpc != null) {
 459                 final String rpcName = BindingMapping.getClassName(rpc.getQName());
 460                 final String rpcMethodName = parseToValidParamName(rpcName);
 461                 final String rpcComment = rpc.getDescription();
 462                 final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);
 463                 final ContainerSchemaNode input = rpc.getInput();
 464                 final ContainerSchemaNode output = rpc.getOutput();
 465
 466                 if (input != null) {
 467                     final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
 468                     addImplementedInterfaceFromUses(input, inType);
 469                     inType.addImplementsType(DATA_OBJECT);
 470                     inType.addImplementsType(augmentable(inType));
 471                     resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
 472                     genCtx.get(module).addChildNodeType(input, inType);
 473                     final GeneratedType inTypeInstance = inType.toInstance();
 474                     method.addParameter(inTypeInstance, "input");
 475                 }
 476
 477                 Type outTypeInstance = VOID;
 478                 if (output != null) {
 479                     final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
 480                     addImplementedInterfaceFromUses(output, outType);
 481                     outType.addImplementsType(DATA_OBJECT);
 482                     outType.addImplementsType(augmentable(outType));
 483                     resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
 484                     genCtx.get(module).addChildNodeType(output, outType);
 485                     outTypeInstance = outType.toInstance();
 486                 }
 487
 488                 final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
 489                 method.setComment(rpcComment);
 490                 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
 491             }
 492         }
 493
 494         genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
 495     }
 496
 497     /**
 498      * Converts all <b>notifications</b> of the module to the list of
 499      * <code>Type</code> objects. In addition are to this list added containers
 500      * and lists which are part of this notification.
 501      *
 502      * @param module
 503      *            module from which is obtained set of all notification objects
 504      *            to iterate over them
 505      * @throws IllegalArgumentException
 506      *             <ul>
 507      *             <li>if the module equals null</li>
 508      *             <li>if the name of module equals null</li>
 509      *             </ul>
 510      * @throws IllegalStateException
 511      *             if set of notifications from module is null
 512      */
 513     private void notificationsToGenType(final Module module) {
 514         checkArgument(module != null, "Module reference cannot be NULL.");
 515         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 516         final Set<NotificationDefinition> notifications = module.getNotifications();
 517         checkState(notifications != null, "Set of notification from module " + module.getName() + " cannot be NULL.");
 518         if (notifications.isEmpty()) {
 519             return;
 520         }
 521
 522         final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
 523         listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
 524         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 525
 526
 527
 528         for (NotificationDefinition notification : notifications) {
 529             if (notification != null) {
 530                 processUsesAugments(notification, module);
 531
 532                 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
 533                         notification, BindingTypes.DATA_OBJECT);
 534                 notificationInterface.addImplementsType(NOTIFICATION);
 535                 genCtx.get(module).addChildNodeType(notification, notificationInterface);
 536
 537                 // Notification object
 538                 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
 539                         notification.getChildNodes());
 540
 541                 listenerInterface.addMethod("on" + notificationInterface.getName())
 542                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 543                 .setComment(notification.getDescription()).setReturnType(Types.VOID);
 544             }
 545         }
 546         listenerInterface.setDescription(createDescription(notifications, module.getName(), module.getModuleSourcePath()));
 547
 548         genCtx.get(module).addTopLevelNodeType(listenerInterface);
 549     }
 550
 551     /**
 552      * Converts all <b>identities</b> of the module to the list of
 553      * <code>Type</code> objects.
 554      *
 555      * @param module
 556      *            module from which is obtained set of all identity objects to
 557      *            iterate over them
 558      * @param context
 559      *            schema context only used as input parameter for method
 560      *            {@link identityToGenType}
 561      *
 562      */
 563     private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
 564         final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
 565         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 566
 567         if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
 568             for (IdentitySchemaNode identity : schemaIdentities) {
 569                 identityToGenType(module, basePackageName, identity, context);
 570             }
 571         }
 572     }
 573
 574     /**
 575      * Converts the <b>identity</b> object to GeneratedType. Firstly it is
 576      * created transport object builder. If identity contains base identity then
 577      * reference to base identity is added to superior identity as its extend.
 578      * If identity doesn't contain base identity then only reference to abstract
 579      * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
 580      * BaseIdentity} is added
 581      *
 582      * @param module
 583      *            current module
 584      * @param basePackageName
 585      *            string contains the module package name
 586      * @param identity
 587      *            IdentitySchemaNode which contains data about identity
 588      * @param context
 589      *            SchemaContext which is used to get package and name
 590      *            information about base of identity
 591      *
 592      */
 593     private void identityToGenType(final Module module, final String basePackageName,
 594             final IdentitySchemaNode identity, final SchemaContext context) {
 595         if (identity == null) {
 596             return;
 597         }
 598         final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
 599         final String genTypeName = BindingMapping.getClassName(identity.getQName());
 600         final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
 601         final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
 602         if (baseIdentity == null) {
 603             final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
 604                     BaseIdentity.class.getSimpleName());
 605             newType.setExtendsType(gto.toInstance());
 606         } else {
 607             final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
 608             final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
 609                     .getQNameModule());
 610             final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
 611             final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
 612             .toInstance();
 613             newType.setExtendsType(gto);
 614         }
 615         newType.setAbstract(true);
 616         newType.addComment(identity.getDescription());
 617         newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
 618         newType.setReference(identity.getReference());
 619         newType.setModuleName(module.getName());
 620         SchemaPath path = identity.getPath();
 621         newType.setSchemaPath(identity.getPath().getPathFromRoot());
 622
 623         final QName qname = identity.getQName();
 624         qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
 625
 626         genCtx.get(module).addIdentityType(identity.getQName(), newType);
 627     }
 628
 629     private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
 630             final QName name) {
 631         StringBuilder sb = new StringBuilder("org.opendaylight.yangtools.yang.common.QName");
 632         sb.append(".create(");
 633         sb.append('"');
 634         sb.append(name.getNamespace());
 635         sb.append("\",\"");
 636         sb.append(name.getFormattedRevision());
 637         sb.append("\",\"");
 638         sb.append(name.getLocalName());
 639         sb.append("\");");
 640
 641         return toBuilder.addConstant(typeForClass(QName.class), constantName, sb.toString());
 642     }
 643
 644     /**
 645      * Converts all <b>groupings</b> of the module to the list of
 646      * <code>Type</code> objects. Firstly are groupings sorted according mutual
 647      * dependencies. At least dependent (independent) groupings are in the list
 648      * saved at first positions. For every grouping the record is added to map
 649      * {@link BindingGeneratorImpl#allGroupings allGroupings}
 650      *
 651      * @param module
 652      *            current module
 653      * @param collection
 654      *            of groupings from which types will be generated
 655      *
 656      */
 657     private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
 658         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 659         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
 660         .sort(groupings);
 661         for (GroupingDefinition grouping : groupingsSortedByDependencies) {
 662             groupingToGenType(basePackageName, grouping, module);
 663         }
 664     }
 665
 666     /**
 667      * Converts individual grouping to GeneratedType. Firstly generated type
 668      * builder is created and every child node of grouping is resolved to the
 669      * method.
 670      *
 671      * @param basePackageName
 672      *            string contains the module package name
 673      * @param grouping
 674      *            GroupingDefinition which contains data about grouping
 675      * @param module
 676      *            current module
 677      * @return GeneratedType which is generated from grouping (object of type
 678      *         <code>GroupingDefinition</code>)
 679      */
 680     private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
 681         final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
 682         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping);
 683         genCtx.get(module).addGroupingType(grouping.getPath(), genType);
 684         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
 685         groupingsToGenTypes(module, grouping.getGroupings());
 686         processUsesAugments(grouping, module);
 687     }
 688
 689     /**
 690      * Adds enumeration builder created from <code>enumTypeDef</code> to
 691      * <code>typeBuilder</code>.
 692      *
 693      * Each <code>enumTypeDef</code> item is added to builder with its name and
 694      * value.
 695      *
 696      * @param enumTypeDef
 697      *            EnumTypeDefinition contains enum data
 698      * @param enumName
 699      *            string contains name which will be assigned to enumeration
 700      *            builder
 701      * @param typeBuilder
 702      *            GeneratedTypeBuilder to which will be enum builder assigned
 703      * @return enumeration builder which contains data from
 704      *         <code>enumTypeDef</code>
 705      */
 706     private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
 707             final GeneratedTypeBuilder typeBuilder) {
 708         if ((enumTypeDef != null) && (typeBuilder != null) && (enumTypeDef.getQName() != null)
 709                 && (enumTypeDef.getQName().getLocalName() != null)) {
 710             final String enumerationName = BindingMapping.getClassName(enumName);
 711             final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
 712             enumBuilder.setDescription(enumTypeDef.getDescription());
 713             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
 714             return enumBuilder;
 715         }
 716         return null;
 717     }
 718
 719     /**
 720      * Generates type builder for <code>module</code>.
 721      *
 722      * @param module
 723      *            Module which is source of package name for generated type
 724      *            builder
 725      * @param postfix
 726      *            string which is added to the module class name representation
 727      *            as suffix
 728      * @return instance of GeneratedTypeBuilder which represents
 729      *         <code>module</code>.
 730      * @throws IllegalArgumentException
 731      *             if <code>module</code> is null
 732      */
 733     private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
 734         checkArgument(module != null, "Module reference cannot be NULL.");
 735         final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
 736         final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
 737
 738         final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
 739         moduleBuilder.setDescription(createDescription(module));
 740         moduleBuilder.setReference(module.getReference());
 741         moduleBuilder.setModuleName(moduleName);
 742
 743         return moduleBuilder;
 744     }
 745
 746     /**
 747      * Converts <code>augSchema</code> to list of <code>Type</code> which
 748      * contains generated type for augmentation. In addition there are also
 749      * generated types for all containers, list and choices which are child of
 750      * <code>augSchema</code> node or a generated types for cases are added if
 751      * augmented node is choice.
 752      *
 753      * @param augmentPackageName
 754      *            string with the name of the package to which the augmentation
 755      *            belongs
 756      * @param augSchema
 757      *            AugmentationSchema which is contains data about augmentation
 758      *            (target path, childs...)
 759      * @param module
 760      *            current module
 761      * @param parentUsesNode
 762      * @throws IllegalArgumentException
 763      *             <ul>
 764      *             <li>if <code>augmentPackageName</code> equals null</li>
 765      *             <li>if <code>augSchema</code> equals null</li>
 766      *             </ul>
 767      * @throws IllegalStateException
 768      *             if augment target path is null
 769      */
 770     private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
 771             final Module module) {
 772         checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
 773         checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
 774         checkState(augSchema.getTargetPath() != null,
 775                 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 776
 777         processUsesAugments(augSchema, module);
 778         final SchemaPath targetPath = augSchema.getTargetPath();
 779         SchemaNode targetSchemaNode = null;
 780
 781         targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
 782         if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
 783             if (targetSchemaNode instanceof DerivableSchemaNode) {
 784                 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
 785             }
 786             if (targetSchemaNode == null) {
 787                 throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
 788                         + " in module " + module.getName());
 789             }
 790         }
 791         if (targetSchemaNode == null) {
 792             throw new IllegalArgumentException("augment target not found: " + targetPath);
 793         }
 794
 795         GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
 796         if (targetTypeBuilder == null) {
 797             targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
 798         }
 799         if (targetTypeBuilder == null) {
 800             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 801         }
 802
 803         if (!(targetSchemaNode instanceof ChoiceNode)) {
 804             String packageName = augmentPackageName;
 805             final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
 806                     targetTypeBuilder.getName());
 807             addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetType, augSchema);
 808
 809         } else {
 810             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
 811                     (ChoiceNode) targetSchemaNode, augSchema.getChildNodes());
 812         }
 813     }
 814
 815     private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
 816             final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
 817         checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
 818         checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
 819         checkState(augSchema.getTargetPath() != null,
 820                 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 821
 822         processUsesAugments(augSchema, module);
 823         final SchemaPath targetPath = augSchema.getTargetPath();
 824         SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
 825         if (targetSchemaNode == null) {
 826             throw new IllegalArgumentException("augment target not found: " + targetPath);
 827         }
 828
 829         GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
 830         if (targetTypeBuilder == null) {
 831             targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
 832         }
 833         if (targetTypeBuilder == null) {
 834             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 835         }
 836
 837         if (!(targetSchemaNode instanceof ChoiceNode)) {
 838             String packageName = augmentPackageName;
 839             if (usesNodeParent instanceof SchemaNode) {
 840                 packageName = packageNameForGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath(),
 841                         true);
 842             }
 843             addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
 844                     augSchema);
 845         } else {
 846             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
 847                     (ChoiceNode) targetSchemaNode, augSchema.getChildNodes());
 848         }
 849     }
 850
 851     /**
 852      * Convenient method to find node added by uses statement.
 853      *
 854      * @param targetPath
 855      *            node path
 856      * @param parentUsesNode
 857      *            parent of uses node
 858      * @return node from its original location in grouping
 859      */
 860     private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
 861         SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
 862                 .getPathFromRoot());
 863         if (!(targetGrouping instanceof GroupingDefinition)) {
 864             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 865         }
 866
 867         GroupingDefinition grouping = (GroupingDefinition) targetGrouping;
 868         SchemaNode result = grouping;
 869         for (QName node : targetPath.getPathFromRoot()) {
 870             // finding by local name is valid, grouping cannot contain nodes
 871             // with same name and different namespace
 872             if (result instanceof DataNodeContainer) {
 873                 result = ((DataNodeContainer) result).getDataChildByName(node.getLocalName());
 874             } else if (result instanceof ChoiceNode) {
 875                 result = ((ChoiceNode) result).getCaseNodeByName(node.getLocalName());
 876             }
 877         }
 878         if (result == null) {
 879             return null;
 880         }
 881
 882         boolean fromUses = ((DataSchemaNode) result).isAddedByUses();
 883         Iterator<UsesNode> groupingUses = grouping.getUses().iterator();
 884         while (groupingUses.hasNext() && fromUses) {
 885             result = findOriginalTargetFromGrouping(targetPath, groupingUses.next());
 886             if (result != null) {
 887                 fromUses = ((DataSchemaNode) result).isAddedByUses();
 888             }
 889         }
 890         if (fromUses) {
 891             // this indicates invalid yang and thus possible bug in code because
 892             // invalid yang should be already spotted by parser
 893             throw new IllegalStateException("Failed to generate code for augment in " + parentUsesNode);
 894         }
 895
 896         return (DataSchemaNode) result;
 897     }
 898
 899     /**
 900      * Returns a generated type builder for an augmentation.
 901      *
 902      * The name of the type builder is equal to the name of augmented node with
 903      * serial number as suffix.
 904      *
 905      * @param module
 906      *            current module
 907      * @param augmentPackageName
 908      *            string with contains the package name to which the augment
 909      *            belongs
 910      * @param basePackageName
 911      *            string with the package name to which the augmented node
 912      *            belongs
 913      * @param targetTypeRef
 914      *            target type
 915      * @param augSchema
 916      *            augmentation schema which contains data about the child nodes
 917      *            and uses of augment
 918      * @return generated type builder for augment
 919      */
 920     private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
 921             final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
 922         Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
 923         if (augmentBuilders == null) {
 924             augmentBuilders = new HashMap<>();
 925             genTypeBuilders.put(augmentPackageName, augmentBuilders);
 926         }
 927         final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
 928
 929         String augTypeName;
 930         if (augIdentifier != null) {
 931             augTypeName = BindingMapping.getClassName(augIdentifier);
 932         } else {
 933             augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 934         }
 935
 936         final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
 937
 938         augTypeBuilder.addImplementsType(DATA_OBJECT);
 939         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 940         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
 941
 942         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
 943         augmentBuilders.put(augTypeName, augTypeBuilder);
 944
 945         if(!augSchema.getChildNodes().isEmpty()) {
 946             genCtx.get(module).addTargetToAugmentation(targetTypeRef, augTypeBuilder);
 947             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
 948
 949         }
 950         genCtx.get(module).addAugmentType(augTypeBuilder);
 951         return augTypeBuilder;
 952     }
 953
 954     /**
 955      *
 956      * @param unknownSchemaNodes
 957      * @return nodeParameter of UnknownSchemaNode
 958      */
 959     private String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
 960         for (UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
 961             final QName nodeType = unknownSchemaNode.getNodeType();
 962             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
 963                     && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
 964                 return unknownSchemaNode.getNodeParameter();
 965             }
 966         }
 967         return null;
 968     }
 969
 970     /**
 971      * Returns first unique name for the augment generated type builder. The
 972      * generated type builder name for augment consists from name of augmented
 973      * node and serial number of its augmentation.
 974      *
 975      * @param builders
 976      *            map of builders which were created in the package to which the
 977      *            augmentation belongs
 978      * @param genTypeName
 979      *            string with name of augmented node
 980      * @return string with unique name for augmentation builder
 981      */
 982     private String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
 983         int index = 1;
 984         if (builders != null) {
 985             while (builders.containsKey(genTypeName + index)) {
 986                 index = index + 1;
 987             }
 988         }
 989         return genTypeName + index;
 990     }
 991
 992     /**
 993      * Adds the methods to <code>typeBuilder</code> which represent subnodes of
 994      * node for which <code>typeBuilder</code> was created.
 995      *
 996      * The subnodes aren't mapped to the methods if they are part of grouping or
 997      * augment (in this case are already part of them).
 998      *
 999      * @param module
1000      *            current module
1001      * @param basePackageName
1002      *            string contains the module package name
1003      * @param parent
1004      *            generated type builder which represents any node. The subnodes
1005      *            of this node are added to the <code>typeBuilder</code> as
1006      *            methods. The subnode can be of type leaf, leaf-list, list,
1007      *            container, choice.
1008      * @param childOf
1009      *            parent type
1010      * @param schemaNodes
1011      *            set of data schema nodes which are the children of the node
1012      *            for which <code>typeBuilder</code> was created
1013      * @return generated type builder which is the same builder as input
1014      *         parameter. The getter methods (representing child nodes) could be
1015      *         added to it.
1016      */
1017     private GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
1018             final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
1019         if (schemaNodes != null && parent != null) {
1020             for (DataSchemaNode schemaNode : schemaNodes) {
1021                 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
1022                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1023                 }
1024             }
1025         }
1026         return parent;
1027     }
1028
1029     /**
1030      * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1031      * node for which <code>typeBuilder</code> was created.
1032      *
1033      * @param module
1034      *            current module
1035      * @param basePackageName
1036      *            string contains the module package name
1037      * @param typeBuilder
1038      *            generated type builder which represents any node. The subnodes
1039      *            of this node are added to the <code>typeBuilder</code> as
1040      *            methods. The subnode can be of type leaf, leaf-list, list,
1041      *            container, choice.
1042      * @param childOf
1043      *            parent type
1044      * @param schemaNodes
1045      *            set of data schema nodes which are the children of the node
1046      *            for which <code>typeBuilder</code> was created
1047      * @return generated type builder which is the same object as the input
1048      *         parameter <code>typeBuilder</code>. The getter method could be
1049      *         added to it.
1050      */
1051     private GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
1052             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
1053             final Iterable<DataSchemaNode> schemaNodes) {
1054         if ((schemaNodes != null) && (typeBuilder != null)) {
1055             for (DataSchemaNode schemaNode : schemaNodes) {
1056                 if (!schemaNode.isAugmenting()) {
1057                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1058                 }
1059             }
1060         }
1061         return typeBuilder;
1062     }
1063
1064     /**
1065      * Adds to <code>typeBuilder</code> a method which is derived from
1066      * <code>schemaNode</code>.
1067      *
1068      * @param basePackageName
1069      *            string with the module package name
1070      * @param node
1071      *            data schema node which is added to <code>typeBuilder</code> as
1072      *            a method
1073      * @param typeBuilder
1074      *            generated type builder to which is <code>schemaNode</code>
1075      *            added as a method.
1076      * @param childOf
1077      *            parent type
1078      * @param module
1079      *            current module
1080      */
1081     private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
1082             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
1083         if (node != null && typeBuilder != null) {
1084             if (node instanceof LeafSchemaNode) {
1085                 resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node);
1086             } else if (node instanceof LeafListSchemaNode) {
1087                 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node);
1088             } else if (node instanceof ContainerSchemaNode) {
1089                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
1090             } else if (node instanceof ListSchemaNode) {
1091                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
1092             } else if (node instanceof ChoiceNode) {
1093                 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceNode) node);
1094             } else {
1095                 // TODO: anyxml not yet supported
1096                 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
1097                         typeBuilder.getFullyQualifiedName());
1098             }
1099         }
1100     }
1101
1102     /**
1103      * Converts <code>choiceNode</code> to the list of generated types for
1104      * choice and its cases.
1105      *
1106      * The package names for choice and for its cases are created as
1107      * concatenation of the module package (<code>basePackageName</code>) and
1108      * names of all parents node.
1109      *
1110      * @param module
1111      *            current module
1112      * @param basePackageName
1113      *            string with the module package name
1114      * @param parent
1115      *            parent type
1116      * @param choiceNode
1117      *            choice node which is mapped to generated type. Also child
1118      *            nodes - cases are mapped to generated types.
1119      * @throws IllegalArgumentException
1120      *             <ul>
1121      *             <li>if <code>basePackageName</code> is null</li>
1122      *             <li>if <code>choiceNode</code> is null</li>
1123      *             </ul>
1124      */
1125     private void choiceToGeneratedType(final Module module, final String basePackageName,
1126             final GeneratedTypeBuilder parent, final ChoiceNode choiceNode) {
1127         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1128         checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
1129
1130         if (!choiceNode.isAddedByUses()) {
1131             final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
1132             final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1133             constructGetter(parent, choiceNode.getQName().getLocalName(), choiceNode.getDescription(),
1134                     choiceTypeBuilder);
1135             choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
1136             genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
1137             generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
1138         }
1139     }
1140
1141     /**
1142      * Converts <code>caseNodes</code> set to list of corresponding generated
1143      * types.
1144      *
1145      * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1146      * created generated type builder. The package names for the builder is
1147      * created as concatenation of the module package (
1148      * <code>basePackageName</code>) and names of all parents nodes of the
1149      * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1150      * between every case builder and <i>choice</i> type
1151      *
1152      * @param module
1153      *            current module
1154      * @param basePackageName
1155      *            string with the module package name
1156      * @param refChoiceType
1157      *            type which represents superior <i>case</i>
1158      * @param choiceNode
1159      *            choice case node which is mapped to generated type
1160      * @return list of generated types for <code>caseNodes</code>.
1161      * @throws IllegalArgumentException
1162      *             <ul>
1163      *             <li>if <code>basePackageName</code> equals null</li>
1164      *             <li>if <code>refChoiceType</code> equals null</li>
1165      *             <li>if <code>caseNodes</code> equals null</li>
1166      *             </ul>
1167      */
1168     private void generateTypesFromChoiceCases(final Module module, final String basePackageName,
1169             final Type refChoiceType, final ChoiceNode choiceNode) {
1170         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1171         checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1172         checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1173
1174         final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1175         if (caseNodes == null) {
1176             return;
1177         }
1178
1179         for (ChoiceCaseNode caseNode : caseNodes) {
1180             if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1181                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1182                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1183                 caseTypeBuilder.addImplementsType(refChoiceType);
1184                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1185                 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1186                 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1187                 if (caseChildNodes != null) {
1188                     Object parentNode = null;
1189                     final SchemaPath nodeSp = choiceNode.getPath();
1190                     parentNode = findDataSchemaNode(schemaContext, nodeSp.getParent());
1191
1192                     SchemaNode parent;
1193                     if (parentNode instanceof AugmentationSchema) {
1194                         final AugmentationSchema augSchema = (AugmentationSchema) parentNode;
1195                         final SchemaPath targetPath = augSchema.getTargetPath();
1196                         SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1197                         if (targetSchemaNode instanceof DataSchemaNode
1198                                 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1199                             if (targetSchemaNode instanceof DerivableSchemaNode) {
1200                                 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1201                             }
1202                             if (targetSchemaNode == null) {
1203                                 throw new IllegalStateException(
1204                                         "Failed to find target node from grouping for augmentation " + augSchema
1205                                         + " in module " + module.getName());
1206                             }
1207                         }
1208                         parent = targetSchemaNode;
1209                     } else {
1210                         final SchemaPath sp = choiceNode.getPath();
1211                         parent = findDataSchemaNode(schemaContext, sp.getParent());
1212                     }
1213                     GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
1214                     if (childOfType == null) {
1215                         childOfType = findGroupingByPath(parent.getPath());
1216                     }
1217                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
1218                 }
1219             }
1220
1221             processUsesAugments(caseNode, module);
1222         }
1223     }
1224
1225     /**
1226      * Generates list of generated types for all the cases of a choice which are
1227      * added to the choice through the augment.
1228      *
1229      * @param module
1230      *            current module
1231      * @param basePackageName
1232      *            string contains name of package to which augment belongs. If
1233      *            an augmented choice is from an other package (pcg1) than an
1234      *            augmenting choice (pcg2) then case's of the augmenting choice
1235      *            will belong to pcg2.
1236      * @param targetType
1237      *            Type which represents target choice
1238      * @param targetNode
1239      *            node which represents target choice
1240      * @param augmentedNodes
1241      *            set of choice case nodes for which is checked if are/aren't
1242      *            added to choice through augmentation
1243      * @return list of generated types which represents augmented cases of
1244      *         choice <code>refChoiceType</code>
1245      * @throws IllegalArgumentException
1246      *             <ul>
1247      *             <li>if <code>basePackageName</code> is null</li>
1248      *             <li>if <code>targetType</code> is null</li>
1249      *             <li>if <code>augmentedNodes</code> is null</li>
1250      *             </ul>
1251      */
1252     private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
1253             final Type targetType, final ChoiceNode targetNode, final Iterable<DataSchemaNode> augmentedNodes) {
1254         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1255         checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
1256         checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
1257
1258         for (DataSchemaNode caseNode : augmentedNodes) {
1259             if (caseNode != null) {
1260                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1261                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1262                 caseTypeBuilder.addImplementsType(targetType);
1263
1264                 SchemaNode parent = null;
1265                 final SchemaPath nodeSp = targetNode.getPath();
1266                 parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
1267
1268                 GeneratedTypeBuilder childOfType = null;
1269                 if (parent instanceof Module) {
1270                     childOfType = genCtx.get(parent).getModuleNode();
1271                 } else if (parent instanceof ChoiceCaseNode) {
1272                     childOfType = findCaseByPath(parent.getPath());
1273                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1274                     childOfType = findChildNodeByPath(parent.getPath());
1275                 } else if (parent instanceof GroupingDefinition) {
1276                     childOfType = findGroupingByPath(parent.getPath());
1277                 }
1278
1279                 if (childOfType == null) {
1280                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1281                 }
1282
1283                 ChoiceCaseNode node = null;
1284                 if (caseNode instanceof ChoiceCaseNode) {
1285                     node = (ChoiceCaseNode) caseNode;
1286                 } else {
1287                     node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1288                 }
1289                 final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
1290                 if (childNodes != null) {
1291                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1292                 }
1293                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1294                 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
1295             }
1296         }
1297     }
1298
1299     /**
1300      * Converts <code>leaf</code> to the getter method which is added to
1301      * <code>typeBuilder</code>.
1302      *
1303      * @param typeBuilder
1304      *            generated type builder to which is added getter method as
1305      *            <code>leaf</code> mapping
1306      * @param leaf
1307      *            leaf schema node which is mapped as getter method which is
1308      *            added to <code>typeBuilder</code>
1309      * @return boolean value
1310      *         <ul>
1311      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1312      *         null</li>
1313      *         <li>true - in other cases</li>
1314      *         </ul>
1315      */
1316     private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) {
1317         Type returnType = null;
1318         if ((leaf != null) && (typeBuilder != null)) {
1319             final String leafName = leaf.getQName().getLocalName();
1320             String leafDesc = leaf.getDescription();
1321             if (leafDesc == null) {
1322                 leafDesc = "";
1323             }
1324
1325             final Module parentModule = findParentModule(schemaContext, leaf);
1326             if (leafName != null && !leaf.isAddedByUses()) {
1327                 final TypeDefinition<?> typeDef = leaf.getType();
1328
1329                 GeneratedTOBuilder genTOBuilder;
1330                 if (typeDef instanceof EnumTypeDefinition) {
1331                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1332                     final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1333                     final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
1334                             typeBuilder);
1335
1336                     if (enumBuilder != null) {
1337                         returnType = enumBuilder.toInstance(typeBuilder);
1338                     }
1339                     ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1340                 } else if (typeDef instanceof UnionType) {
1341                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1342                     if (genTOBuilder != null) {
1343                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1344                     }
1345                 } else if (typeDef instanceof BitsTypeDefinition) {
1346                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1347                     if (genTOBuilder != null) {
1348                         returnType = new ReferencedTypeImpl(genTOBuilder.getPackageName(), genTOBuilder.getName());
1349                     }
1350                 } else {
1351                     final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1352                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1353                 }
1354                 if (returnType != null) {
1355                     final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1356                     processContextRefExtension(leaf, getter, parentModule);
1357                 }
1358             }
1359         }
1360         return returnType;
1361     }
1362
1363     private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
1364             final Module module) {
1365         for (UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
1366             final QName nodeType = node.getNodeType();
1367             if ("context-reference".equals(nodeType.getLocalName())) {
1368                 final String nodeParam = node.getNodeParameter();
1369                 IdentitySchemaNode identity = null;
1370                 String basePackageName = null;
1371                 final Iterable<String> splittedElement = Splitter.on(':').split(nodeParam);
1372                 final Iterator<String> iterator = splittedElement.iterator();
1373                 final int length = Iterables.size(splittedElement);
1374                 if (length == 1) {
1375                     identity = findIdentityByName(module.getIdentities(), iterator.next());
1376                     basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1377                 } else if (length == 2) {
1378                     String prefix = iterator.next();
1379                     final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
1380                     if (dependentModule == null) {
1381                         throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
1382                                 + prefix);
1383                     }
1384                     identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
1385                     basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
1386                 } else {
1387                     throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1388                             + nodeParam);
1389                 }
1390                 if (identity == null) {
1391                     throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1392                             + nodeParam);
1393                 }
1394
1395                 final Class<RoutingContext> clazz = RoutingContext.class;
1396                 final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
1397                         clazz.getSimpleName());
1398                 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
1399                 final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
1400                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1401             }
1402         }
1403     }
1404
1405     private IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
1406         for (IdentitySchemaNode id : identities) {
1407             if (id.getQName().getLocalName().equals(name)) {
1408                 return id;
1409             }
1410         }
1411         return null;
1412     }
1413
1414     private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
1415         for (ModuleImport imp : imports) {
1416             if (imp.getPrefix().equals(prefix)) {
1417                 return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
1418             }
1419         }
1420         return null;
1421     }
1422
1423     private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1424             final boolean isReadOnly, final Module module) {
1425         if ((leaf != null) && (toBuilder != null)) {
1426             final String leafName = leaf.getQName().getLocalName();
1427             String leafDesc = leaf.getDescription();
1428             if (leafDesc == null) {
1429                 leafDesc = "";
1430             }
1431
1432             if (leafName != null) {
1433                 Type returnType = null;
1434                 final TypeDefinition<?> typeDef = leaf.getType();
1435                 if (typeDef instanceof UnionTypeDefinition) {
1436                     // GeneratedType for this type definition should be already
1437                     // created
1438                     QName qname = typeDef.getQName();
1439                     Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1440                             qname.getRevision());
1441                     final ModuleContext mc = genCtx.get(unionModule);
1442                     returnType = mc.getTypedefs().get(typeDef.getPath());
1443                 } else {
1444                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1445                 }
1446                 return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1447             }
1448         }
1449         return false;
1450     }
1451
1452     /**
1453      * Converts <code>leaf</code> schema node to property of generated TO
1454      * builder.
1455      *
1456      * @param toBuilder
1457      *            generated TO builder to which is <code>leaf</code> added as
1458      *            property
1459      * @param leaf
1460      *            leaf schema node which is added to <code>toBuilder</code> as
1461      *            property
1462      * @param returnType
1463      *            property type
1464      * @param isReadOnly
1465      *            boolean value which says if leaf property is|isn't read only
1466      * @return boolean value
1467      *         <ul>
1468      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1469      *         name equals null or if leaf is added by <i>uses</i>.</li>
1470      *         <li>true - other cases</li>
1471      *         </ul>
1472      */
1473     private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1474             final Type returnType, final boolean isReadOnly) {
1475         if (returnType == null) {
1476             return false;
1477         }
1478         final String leafName = leaf.getQName().getLocalName();
1479         final String leafDesc = leaf.getDescription();
1480         final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1481         propBuilder.setReadOnly(isReadOnly);
1482         propBuilder.setReturnType(returnType);
1483         propBuilder.setComment(leafDesc);
1484         toBuilder.addEqualsIdentity(propBuilder);
1485         toBuilder.addHashIdentity(propBuilder);
1486         toBuilder.addToStringProperty(propBuilder);
1487         return true;
1488     }
1489
1490     /**
1491      * Converts <code>node</code> leaf list schema node to getter method of
1492      * <code>typeBuilder</code>.
1493      *
1494      * @param typeBuilder
1495      *            generated type builder to which is <code>node</code> added as
1496      *            getter method
1497      * @param node
1498      *            leaf list schema node which is added to
1499      *            <code>typeBuilder</code> as getter method
1500      * @return boolean value
1501      *         <ul>
1502      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,
1503      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1504      *         <li>false - other cases</li>
1505      *         </ul>
1506      */
1507     private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node) {
1508         if ((node != null) && (typeBuilder != null)) {
1509             final QName nodeName = node.getQName();
1510
1511             if (nodeName != null && !node.isAddedByUses()) {
1512                 final TypeDefinition<?> typeDef = node.getType();
1513                 final Module parentModule = findParentModule(schemaContext, node);
1514
1515                 Type returnType = null;
1516                 if (typeDef instanceof EnumTypeDefinition) {
1517                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1518                     final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1519                     final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
1520                             typeBuilder);
1521                     returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
1522                     ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1523                 } else if (typeDef instanceof UnionType) {
1524                     final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1525                     if (genTOBuilder != null) {
1526                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1527                     }
1528                 } else if (typeDef instanceof BitsTypeDefinition) {
1529                     final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1530                     returnType = new ReferencedTypeImpl(genTOBuilder.getPackageName(), genTOBuilder.getName());
1531                 } else {
1532                     final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1533                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1534                 }
1535
1536                 final ParameterizedType listType = Types.listTypeFor(returnType);
1537                 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType);
1538                 return true;
1539             }
1540         }
1541         return false;
1542     }
1543
1544     private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
1545             final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
1546         final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
1547                 genTOBuilder.getName());
1548
1549         returnType.setDescription(typeDef.getDescription());
1550         returnType.setReference(typeDef.getReference());
1551         returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
1552         returnType.setModuleName(parentModule.getName());
1553
1554         genTOBuilder.setTypedef(true);
1555         genTOBuilder.setIsUnion(true);
1556         ((TypeProviderImpl) typeProvider).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1557
1558         // union builder
1559         final GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1560                 genTOBuilder.getName() + "Builder");
1561         unionBuilder.setIsUnionBuilder(true);
1562         final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1563         method.setReturnType(returnType);
1564         method.addParameter(Types.STRING, "defaultValue");
1565         method.setAccessModifier(AccessModifier.PUBLIC);
1566         method.setStatic(true);
1567
1568         final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
1569         if (types == null) {
1570             ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
1571                     Sets.<Type> newHashSet(unionBuilder.toInstance()));
1572         } else {
1573             types.add(unionBuilder.toInstance());
1574         }
1575         return returnType.toInstance();
1576     }
1577
1578     private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1579         return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1580     }
1581
1582     /**
1583      * Instantiates generated type builder with <code>packageName</code> and
1584      * <code>schemaNode</code>.
1585      *
1586      * The new builder always implements
1587      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
1588      * If <code>schemaNode</code> is instance of GroupingDefinition it also
1589      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1590      * Augmentable}.<br />
1591      * If <code>schemaNode</code> is instance of
1592      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1593      * DataNodeContainer} it can also implement nodes which are specified in
1594      * <i>uses</i>.
1595      *
1596      * @param packageName
1597      *            string with the name of the package to which
1598      *            <code>schemaNode</code> belongs.
1599      * @param schemaNode
1600      *            schema node for which is created generated type builder
1601      * @param parent
1602      *            parent type (can be null)
1603      * @return generated type builder <code>schemaNode</code>
1604      */
1605     private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1606             final Type parent) {
1607         final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
1608         if (parent == null) {
1609             it.addImplementsType(DATA_OBJECT);
1610         } else {
1611             it.addImplementsType(BindingTypes.childOf(parent));
1612         }
1613         if (!(schemaNode instanceof GroupingDefinition)) {
1614             it.addImplementsType(augmentable(it));
1615         }
1616
1617         if (schemaNode instanceof DataNodeContainer) {
1618             addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
1619         }
1620
1621         return it;
1622     }
1623
1624     /**
1625      * Wraps the calling of the same overloaded method.
1626      *
1627      * @param packageName
1628      *            string with the package name to which returning generated type
1629      *            builder belongs
1630      * @param schemaNode
1631      *            schema node which provide data about the schema node name
1632      * @return generated type builder for <code>schemaNode</code>
1633      */
1634     private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1635         return addRawInterfaceDefinition(packageName, schemaNode, "");
1636     }
1637
1638     /**
1639      * Returns reference to generated type builder for specified
1640      * <code>schemaNode</code> with <code>packageName</code>.
1641      *
1642      * Firstly the generated type builder is searched in
1643      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1644      * found it is created and added to <code>genTypeBuilders</code>.
1645      *
1646      * @param packageName
1647      *            string with the package name to which returning generated type
1648      *            builder belongs
1649      * @param schemaNode
1650      *            schema node which provide data about the schema node name
1651      * @param prefix
1652      *            return type name prefix
1653      * @return generated type builder for <code>schemaNode</code>
1654      * @throws IllegalArgumentException
1655      *             <ul>
1656      *             <li>if <code>schemaNode</code> is null</li>
1657      *             <li>if <code>packageName</code> is null</li>
1658      *             <li>if QName of schema node is null</li>
1659      *             <li>if schemaNode name is null</li>
1660      *             </ul>
1661      *
1662      */
1663     private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1664             final String prefix) {
1665         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1666         checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
1667         checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
1668         final String schemaNodeName = schemaNode.getQName().getLocalName();
1669         checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
1670
1671         String genTypeName;
1672         if (prefix == null) {
1673             genTypeName = BindingMapping.getClassName(schemaNodeName);
1674         } else {
1675             genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1676         }
1677
1678         // FIXME: Validation of name conflict
1679         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1680         final Module module = findParentModule(schemaContext, schemaNode);
1681         qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
1682         newType.addComment(schemaNode.getDescription());
1683         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
1684         newType.setReference(schemaNode.getReference());
1685         newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
1686         newType.setModuleName(module.getName());
1687
1688         if (!genTypeBuilders.containsKey(packageName)) {
1689             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
1690             builders.put(genTypeName, newType);
1691             genTypeBuilders.put(packageName, builders);
1692         } else {
1693             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1694             if (!builders.containsKey(genTypeName)) {
1695                 builders.put(genTypeName, newType);
1696             }
1697         }
1698         return newType;
1699     }
1700
1701     /**
1702      * Creates the name of the getter method name from <code>localName</code>.
1703      *
1704      * @param localName
1705      *            string with the name of the getter method
1706      * @param returnType
1707      *            return type
1708      * @return string with the name of the getter method for
1709      *         <code>methodName</code> in JAVA method format
1710      */
1711     public static String getterMethodName(final String localName, final Type returnType) {
1712         final StringBuilder method = new StringBuilder();
1713         if (BOOLEAN.equals(returnType)) {
1714             method.append("is");
1715         } else {
1716             method.append("get");
1717         }
1718         String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
1719         method.append(name);
1720         return method.toString();
1721     }
1722
1723     /**
1724      * Created a method signature builder as part of
1725      * <code>interfaceBuilder</code>.
1726      *
1727      * The method signature builder is created for the getter method of
1728      * <code>schemaNodeName</code>. Also <code>comment</code> and
1729      * <code>returnType</code> information are added to the builder.
1730      *
1731      * @param interfaceBuilder
1732      *            generated type builder for which the getter method should be
1733      *            created
1734      * @param schemaNodeName
1735      *            string with schema node name. The name will be the part of the
1736      *            getter method name.
1737      * @param comment
1738      *            string with comment for the getter method
1739      * @param returnType
1740      *            type which represents the return type of the getter method
1741      * @return method signature builder which represents the getter method of
1742      *         <code>interfaceBuilder</code>
1743      */
1744     private MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
1745             final String schemaNodeName, final String comment, final Type returnType) {
1746         final MethodSignatureBuilder getMethod = interfaceBuilder
1747                 .addMethod(getterMethodName(schemaNodeName, returnType));
1748         getMethod.setComment(comment);
1749         getMethod.setReturnType(returnType);
1750         return getMethod;
1751     }
1752
1753     /**
1754      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1755      * or to <code>genTOBuilder</code> as property.
1756      *
1757      * @param basePackageName
1758      *            string contains the module package name
1759      * @param schemaNode
1760      *            data schema node which should be added as getter method to
1761      *            <code>typeBuilder</code> or as a property to
1762      *            <code>genTOBuilder</code> if is part of the list key
1763      * @param typeBuilder
1764      *            generated type builder for the list schema node
1765      * @param genTOBuilder
1766      *            generated TO builder for the list keys
1767      * @param listKeys
1768      *            list of string which contains names of the list keys
1769      * @param module
1770      *            current module
1771      * @throws IllegalArgumentException
1772      *             <ul>
1773      *             <li>if <code>schemaNode</code> equals null</li>
1774      *             <li>if <code>typeBuilder</code> equals null</li>
1775      *             </ul>
1776      */
1777     private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
1778             final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
1779             final Module module) {
1780         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1781         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1782
1783         if (schemaNode instanceof LeafSchemaNode) {
1784             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1785             final String leafName = leaf.getQName().getLocalName();
1786             final Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1787             if (listKeys.contains(leafName)) {
1788                 if (type == null) {
1789                     resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
1790                 } else {
1791                     resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1792                 }
1793             }
1794         } else if (!schemaNode.isAddedByUses()) {
1795             if (schemaNode instanceof LeafListSchemaNode) {
1796                 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode);
1797             } else if (schemaNode instanceof ContainerSchemaNode) {
1798                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
1799             } else if (schemaNode instanceof ChoiceNode) {
1800                 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceNode) schemaNode);
1801             } else if (schemaNode instanceof ListSchemaNode) {
1802                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
1803             }
1804         }
1805     }
1806
1807     private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
1808             final GeneratedTOBuilder genTOBuilder) {
1809         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1810
1811         if (genTOBuilder != null) {
1812             GeneratedTransferObject genTO = genTOBuilder.toInstance();
1813             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1814             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
1815         }
1816     }
1817
1818     /**
1819      * Selects the names of the list keys from <code>list</code> and returns
1820      * them as the list of the strings
1821      *
1822      * @param list
1823      *            of string with names of the list keys
1824      * @return list of string which represents names of the list keys. If the
1825      *         <code>list</code> contains no keys then the empty list is
1826      *         returned.
1827      */
1828     private List<String> listKeys(final ListSchemaNode list) {
1829         final List<String> listKeys = new ArrayList<>();
1830
1831         List<QName> keyDefinition = list.getKeyDefinition();
1832         if (keyDefinition != null) {
1833             for (QName keyDef : keyDefinition) {
1834                 listKeys.add(keyDef.getLocalName());
1835             }
1836         }
1837         return listKeys;
1838     }
1839
1840     /**
1841      * Generates for the <code>list</code> which contains any list keys special
1842      * generated TO builder.
1843      *
1844      * @param packageName
1845      *            string with package name to which the list belongs
1846      * @param list
1847      *            list schema node which is source of data about the list name
1848      * @return generated TO builder which represents the keys of the
1849      *         <code>list</code> or null if <code>list</code> is null or list of
1850      *         key definitions is null or empty.
1851      */
1852     private GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
1853         GeneratedTOBuilder genTOBuilder = null;
1854         if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
1855             final String listName = list.getQName().getLocalName() + "Key";
1856             final String genTOName = BindingMapping.getClassName(listName);
1857             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1858         }
1859         return genTOBuilder;
1860     }
1861
1862     /**
1863      * Builds generated TO builders for <code>typeDef</code> of type
1864      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
1865      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
1866      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
1867      * enclosing transfer object.
1868      *
1869      * If more then one generated TO builder is created for enclosing then all
1870      * of the generated TO builders are added to <code>typeBuilder</code> as
1871      * enclosing transfer objects.
1872      *
1873      * @param typeDef
1874      *            type definition which can be of type <code>UnionType</code> or
1875      *            <code>BitsTypeDefinition</code>
1876      * @param typeBuilder
1877      *            generated type builder to which is added generated TO created
1878      *            from <code>typeDef</code>
1879      * @param leafName
1880      *            string with name for generated TO builder
1881      * @param leaf
1882      * @return generated TO builder for <code>typeDef</code>
1883      */
1884     private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
1885             final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
1886         final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
1887         final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
1888         final String packageName = typeBuilder.getFullyQualifiedName();
1889         if (typeDef instanceof UnionTypeDefinition) {
1890             final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
1891                     .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
1892                             classNameFromLeaf, leaf);
1893             genTOBuilders.addAll(types);
1894
1895             GeneratedTOBuilder resultTOBuilder = null;
1896             if (!types.isEmpty()) {
1897                 resultTOBuilder = types.remove(0);
1898                 for (GeneratedTOBuilder genTOBuilder : types) {
1899                     resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
1900                 }
1901             }
1902
1903             final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
1904             genPropBuilder.setReturnType(Types.primitiveType("char[]", null));
1905             resultTOBuilder.addEqualsIdentity(genPropBuilder);
1906             resultTOBuilder.addHashIdentity(genPropBuilder);
1907             resultTOBuilder.addToStringProperty(genPropBuilder);
1908
1909         } else if (typeDef instanceof BitsTypeDefinition) {
1910             genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
1911                     packageName, typeDef, classNameFromLeaf, parentModule.getName()));
1912         }
1913         if (genTOBuilders != null && !genTOBuilders.isEmpty()) {
1914             for (GeneratedTOBuilder genTOBuilder : genTOBuilders) {
1915                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1916             }
1917             return genTOBuilders.get(0);
1918         }
1919         return null;
1920
1921     }
1922
1923     /**
1924      * Adds the implemented types to type builder.
1925      *
1926      * The method passes through the list of <i>uses</i> in
1927      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
1928      * generated type from {@link BindingGeneratorImpl#allGroupings
1929      * allGroupings} which is added as <i>implements type</i> to
1930      * <code>builder</code>
1931      *
1932      * @param dataNodeContainer
1933      *            element which contains the list of used YANG groupings
1934      * @param builder
1935      *            builder to which are added implemented types according to
1936      *            <code>dataNodeContainer</code>
1937      * @return generated type builder with all implemented types
1938      */
1939     private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
1940             final GeneratedTypeBuilder builder) {
1941         for (UsesNode usesNode : dataNodeContainer.getUses()) {
1942             if (usesNode.getGroupingPath() != null) {
1943                 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
1944                 if (genType == null) {
1945                     throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
1946                             + builder.getName());
1947                 }
1948
1949                 builder.addImplementsType(genType);
1950                 /*
1951                 builder.addComment(genType.getDescription());
1952                 builder.setDescription(genType.getDescription());
1953                 builder.setModuleName(genType.getModuleName());
1954                 builder.setReference(genType.getReference());
1955                 builder.setSchemaPath(genType.getSchemaPath());
1956                 */
1957             }
1958         }
1959         return builder;
1960     }
1961
1962     private boolean isNullOrEmpty(final Collection<?> list) {
1963         return (list == null || list.isEmpty() ? true : false);
1964     }
1965
1966     private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName, final String moduleSourcePath) {
1967         final StringBuilder sb = new StringBuilder();
1968         final String yangSnipet = YangTemplate.generateYangSnipet(schemaNodes);
1969
1970         if (!isNullOrEmpty(schemaNodes)) {
1971             final SchemaNode node = schemaNodes.iterator().next();
1972
1973             if (node instanceof RpcDefinition) {
1974                 sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
1975             }
1976             else if (node instanceof NotificationDefinition) {
1977                 sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
1978             }
1979         }
1980         sb.append(NEW_LINE);
1981         sb.append("<br />(Source path: <i>");
1982         sb.append(moduleSourcePath);
1983         sb.append("</i>):");
1984         sb.append(NEW_LINE);
1985         sb.append("<pre>");
1986         sb.append(NEW_LINE);
1987         sb.append(yangSnipet);
1988         sb.append("</pre>");
1989         sb.append(NEW_LINE);
1990
1991         return sb.toString();
1992     }
1993
1994     private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
1995         final StringBuilder sb = new StringBuilder();
1996         final Module module = findParentModule(schemaContext, schemaNode);
1997         final String yangSnipet = YangTemplate.generateYangSnipet(schemaNode);
1998         final String formattedDescription = YangTemplate.formatToParagraph(schemaNode.getDescription(), 0);
1999         final StringBuilder linkToBuilderClass = new StringBuilder();
2000         final StringBuilder linkToKeyClass = new StringBuilder();
2001         final Splitter splitter = Splitter.on("\\.");
2002         final String[] namespace = Iterables.toArray(splitter.split(fullyQualifiedName), String.class);
2003         String className = namespace[namespace.length - 1];
2004
2005         if (hasBuilderClass(schemaNode)) {
2006             linkToBuilderClass.append(className);
2007             linkToBuilderClass.append("Builder");
2008
2009             if (schemaNode instanceof ListSchemaNode) {
2010                 linkToKeyClass.append(className);
2011                 linkToKeyClass.append("Key");
2012             }
2013         }
2014
2015         if (!isNullOrEmpty(formattedDescription)) {
2016             sb.append(formattedDescription);
2017             sb.append(NEW_LINE);
2018         }
2019         sb.append("<p>");
2020         sb.append("This class represents the following YANG schema fragment defined in module <b>");
2021         sb.append(module.getName());
2022         sb.append("</b>");
2023         sb.append(NEW_LINE);
2024         sb.append("<br />(Source path: <i>");
2025         sb.append(module.getModuleSourcePath());
2026         sb.append("</i>):");
2027         sb.append(NEW_LINE);
2028         sb.append("<pre>");
2029         sb.append(NEW_LINE);
2030         sb.append(yangSnipet);
2031         sb.append("</pre>");
2032         sb.append(NEW_LINE);
2033         sb.append("The schema path to identify an instance is");
2034         sb.append(NEW_LINE);
2035         sb.append("<i>");
2036         sb.append(YangTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
2037         sb.append("</i>");
2038         sb.append(NEW_LINE);
2039
2040         if (hasBuilderClass(schemaNode)) {
2041             sb.append(NEW_LINE);
2042             sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
2043             sb.append(NEW_LINE);
2044             sb.append("@see ");
2045             sb.append(linkToBuilderClass);
2046             if (schemaNode instanceof ListSchemaNode) {
2047                 sb.append("@see ");
2048                 sb.append(linkToKeyClass);
2049             }
2050             sb.append(NEW_LINE);
2051         }
2052
2053         return sb.toString();
2054     }
2055
2056     private boolean hasBuilderClass(final SchemaNode schemaNode) {
2057         if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
2058                 schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
2059             return true;
2060         }
2061         return false;
2062     }
2063
2064     private boolean isNullOrEmpty(final String string) {
2065         return (string == null || string.isEmpty() ? true : false);
2066     }
2067
2068     private String createDescription(final Module module) {
2069         final StringBuilder sb = new StringBuilder();
2070         final String yangSnipet = YangTemplate.generateYangSnipet(module);
2071         final String formattedDescription = YangTemplate.formatToParagraph(module.getDescription(), 0);
2072
2073         if (!isNullOrEmpty(formattedDescription)) {
2074             sb.append(formattedDescription);
2075             sb.append(NEW_LINE);
2076         }
2077         sb.append("<p>");
2078         sb.append("This class represents the following YANG schema fragment defined in module <b>");
2079         sb.append(module.getName());
2080         sb.append("</b>");
2081         sb.append(NEW_LINE);
2082         sb.append("<br />Source path: <i>");
2083         sb.append(module.getModuleSourcePath());
2084         sb.append("</i>):");
2085         sb.append(NEW_LINE);
2086         sb.append("<pre>");
2087         sb.append(NEW_LINE);
2088         sb.append(yangSnipet);
2089         sb.append("</pre>");
2090
2091         return sb.toString();
2092     }
2093
2094     private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
2095         for (ModuleContext ctx : genCtx.values()) {
2096             GeneratedTypeBuilder result = ctx.getChildNode(path);
2097             if (result != null) {
2098                 return result;
2099             }
2100         }
2101         return null;
2102     }
2103
2104     private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
2105         for (ModuleContext ctx : genCtx.values()) {
2106             GeneratedTypeBuilder result = ctx.getGrouping(path);
2107             if (result != null) {
2108                 return result;
2109             }
2110         }
2111         return null;
2112     }
2113
2114     private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
2115         for (ModuleContext ctx : genCtx.values()) {
2116             GeneratedTypeBuilder result = ctx.getCase(path);
2117             if (result != null) {
2118                 return result;
2119             }
2120         }
2121         return null;
2122     }
2123
2124     public Map<Module, ModuleContext> getModuleContexts() {
2125         return genCtx;
2126     }
2127
2128 }