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