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

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