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