binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/AbstractTypeGenerator.java

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