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

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