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