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

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