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