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