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