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