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 %s cannot be NULL.", module.getName());
 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                     processUsesAugments(input, module);
 519                     final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
 520                     addImplementedInterfaceFromUses(input, inType);
 521                     inType.addImplementsType(DATA_OBJECT);
 522                     inType.addImplementsType(augmentable(inType));
 523                     annotateDeprecatedIfNecessary(rpc.getStatus(), inType);
 524                     resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
 525                     genCtx.get(module).addChildNodeType(input, inType);
 526                     final GeneratedType inTypeInstance = inType.toInstance();
 527                     method.addParameter(inTypeInstance, "input");
 528                 }
 529
 530                 Type outTypeInstance = VOID;
 531                 //in case of implicit RPC output (StatementSource.CONTEXT),
 532                 //stay compatible (Future<RpcResult<Void>> return type generated)
 533                 if (output != null && isExplicitStatement(output)) {
 534                     processUsesAugments(output, module);
 535                     final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
 536                     addImplementedInterfaceFromUses(output, outType);
 537                     outType.addImplementsType(DATA_OBJECT);
 538                     outType.addImplementsType(augmentable(outType));
 539                     annotateDeprecatedIfNecessary(rpc.getStatus(), outType);
 540                     resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
 541                     genCtx.get(module).addChildNodeType(output, outType);
 542                     outTypeInstance = outType.toInstance();
 543                 }
 544
 545                 final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
 546                 method.setComment(rpcComment);
 547                 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
 548             }
 549         }
 550
 551         genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
 552     }
 553
 554     private static boolean isExplicitStatement(ContainerSchemaNode node) {
 555         return node instanceof EffectiveStatement
 556                 && ((EffectiveStatement) node).getDeclared().getStatementSource() == StatementSource.DECLARATION;
 557     }
 558
 559     /**
 560      * Converts all <b>notifications</b> of the module to the list of
 561      * <code>Type</code> objects. In addition are to this list added containers
 562      * and lists which are part of this notification.
 563      *
 564      * @param module
 565      *            module from which is obtained set of all notification objects
 566      *            to iterate over them
 567      * @throws IllegalArgumentException
 568      *             <ul>
 569      *             <li>if the module equals null</li>
 570      *             <li>if the name of module equals null</li>
 571      *             </ul>
 572      * @throws IllegalStateException
 573      *             if set of notifications from module is null
 574      */
 575     private void notificationsToGenType(final Module module) {
 576         checkArgument(module != null, "Module reference cannot be NULL.");
 577         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 578         final Set<NotificationDefinition> notifications = module.getNotifications();
 579         if (notifications.isEmpty()) {
 580             return;
 581         }
 582
 583         final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
 584         listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
 585         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 586
 587
 588
 589         for (final NotificationDefinition notification : notifications) {
 590             if (notification != null) {
 591                 processUsesAugments(notification, module);
 592
 593                 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
 594                         notification, null, module);
 595                 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
 596                 notificationInterface.addImplementsType(NOTIFICATION);
 597                 genCtx.get(module).addChildNodeType(notification, notificationInterface);
 598
 599                 // Notification object
 600                 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
 601                         notification.getChildNodes());
 602
 603                 listenerInterface.addMethod("on" + notificationInterface.getName())
 604                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 605                 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
 606             }
 607         }
 608         listenerInterface.setDescription(createDescription(notifications, module.getName()));
 609
 610         genCtx.get(module).addTopLevelNodeType(listenerInterface);
 611     }
 612
 613     /**
 614      * Converts all <b>identities</b> of the module to the list of
 615      * <code>Type</code> objects.
 616      *
 617      * @param module
 618      *            module from which is obtained set of all identity objects to
 619      *            iterate over them
 620      * @param context
 621      *            schema context only used as input parameter for method
 622      *            {@link BindingGeneratorImpl#identityToGenType}
 623      *
 624      */
 625     private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
 626         final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
 627         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 628
 629         if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
 630             for (final IdentitySchemaNode identity : schemaIdentities) {
 631                 identityToGenType(module, basePackageName, identity, context);
 632             }
 633         }
 634     }
 635
 636     /**
 637      * Converts the <b>identity</b> object to GeneratedType. Firstly it is
 638      * created transport object builder. If identity contains base identity then
 639      * reference to base identity is added to superior identity as its extend.
 640      * If identity doesn't contain base identity then only reference to abstract
 641      * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
 642      * BaseIdentity} is added
 643      *
 644      * @param module
 645      *            current module
 646      * @param basePackageName
 647      *            string contains the module package name
 648      * @param identity
 649      *            IdentitySchemaNode which contains data about identity
 650      * @param context
 651      *            SchemaContext which is used to get package and name
 652      *            information about base of identity
 653      *
 654      */
 655     private void identityToGenType(final Module module, final String basePackageName,
 656             final IdentitySchemaNode identity, final SchemaContext context) {
 657         if (identity == null) {
 658             return;
 659         }
 660         final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
 661         final String genTypeName = BindingMapping.getClassName(identity.getQName());
 662         final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
 663         final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
 664         if (baseIdentity == null) {
 665             final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
 666                     BaseIdentity.class.getSimpleName());
 667             newType.setExtendsType(gto.toInstance());
 668         } else {
 669             final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
 670             final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
 671                     .getQNameModule());
 672             final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
 673             final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
 674             .toInstance();
 675             newType.setExtendsType(gto);
 676         }
 677         newType.setAbstract(true);
 678         newType.addComment(identity.getDescription());
 679         newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
 680         newType.setReference(identity.getReference());
 681         newType.setModuleName(module.getName());
 682         newType.setSchemaPath(identity.getPath().getPathFromRoot());
 683
 684         final QName qname = identity.getQName();
 685         qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
 686
 687         genCtx.get(module).addIdentityType(identity.getQName(), newType);
 688     }
 689
 690     private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
 691             final QName name) {
 692         return toBuilder.addConstant(typeForClass(QName.class), constantName, name);
 693     }
 694
 695     /**
 696      * Converts all <b>groupings</b> of the module to the list of
 697      * <code>Type</code> objects. Firstly are groupings sorted according mutual
 698      * dependencies. At least dependent (independent) groupings are in the list
 699      * saved at first positions. For every grouping the record is added to map
 700      * {@link ModuleContext#groupings allGroupings}
 701      *
 702      * @param module
 703      *            current module
 704      * @param groupings
 705      *            collection of groupings from which types will be generated
 706      *
 707      */
 708     private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
 709         final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
 710         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
 711         .sort(groupings);
 712         for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
 713             groupingToGenType(basePackageName, grouping, module);
 714         }
 715     }
 716
 717     /**
 718      * Converts individual grouping to GeneratedType. Firstly generated type
 719      * builder is created and every child node of grouping is resolved to the
 720      * method.
 721      *
 722      * @param basePackageName
 723      *            string contains the module package name
 724      * @param grouping
 725      *            GroupingDefinition which contains data about grouping
 726      * @param module
 727      *            current module
 728      * @return GeneratedType which is generated from grouping (object of type
 729      *         <code>GroupingDefinition</code>)
 730      */
 731     private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
 732         final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
 733         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module);
 734         annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
 735         genCtx.get(module).addGroupingType(grouping.getPath(), genType);
 736         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
 737         groupingsToGenTypes(module, grouping.getGroupings());
 738         processUsesAugments(grouping, module);
 739     }
 740
 741     /**
 742      * Adds enumeration builder created from <code>enumTypeDef</code> to
 743      * <code>typeBuilder</code>.
 744      *
 745      * Each <code>enumTypeDef</code> item is added to builder with its name and
 746      * value.
 747      *
 748      * @param enumTypeDef
 749      *            EnumTypeDefinition contains enum data
 750      * @param enumName
 751      *            string contains name which will be assigned to enumeration
 752      *            builder
 753      * @param typeBuilder
 754      *            GeneratedTypeBuilder to which will be enum builder assigned
 755      * @param module
 756      *            Module in which type should be generated
 757      * @return enumeration builder which contains data from
 758      *         <code>enumTypeDef</code>
 759      */
 760     private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
 761             final GeneratedTypeBuilder typeBuilder, final Module module) {
 762         if (enumTypeDef != null && typeBuilder != null && enumTypeDef.getQName().getLocalName() != null) {
 763             final String enumerationName = BindingMapping.getClassName(enumName);
 764             final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
 765             final String enumTypedefDescription = encodeAngleBrackets(enumTypeDef.getDescription());
 766             enumBuilder.setDescription(enumTypedefDescription);
 767             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
 768             ModuleContext ctx = genCtx.get(module);
 769             ctx.addInnerTypedefType(enumTypeDef.getPath(), enumBuilder);
 770             return enumBuilder;
 771         }
 772         return null;
 773     }
 774
 775     /**
 776      * Generates type builder for <code>module</code>.
 777      *
 778      * @param module
 779      *            Module which is source of package name for generated type
 780      *            builder
 781      * @param postfix
 782      *            string which is added to the module class name representation
 783      *            as suffix
 784      * @return instance of GeneratedTypeBuilder which represents
 785      *         <code>module</code>.
 786      * @throws IllegalArgumentException
 787      *             if <code>module</code> is null
 788      */
 789     private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
 790         checkArgument(module != null, "Module reference cannot be NULL.");
 791         final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
 792         final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
 793
 794         final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
 795         moduleBuilder.setDescription(createDescription(module));
 796         moduleBuilder.setReference(module.getReference());
 797         moduleBuilder.setModuleName(moduleName);
 798
 799         return moduleBuilder;
 800     }
 801
 802     /**
 803      * Converts <code>augSchema</code> to list of <code>Type</code> which
 804      * contains generated type for augmentation. In addition there are also
 805      * generated types for all containers, list and choices which are child of
 806      * <code>augSchema</code> node or a generated types for cases are added if
 807      * augmented node is choice.
 808      *
 809      * @param augmentPackageName
 810      *            string with the name of the package to which the augmentation
 811      *            belongs
 812      * @param augSchema
 813      *            AugmentationSchema which is contains data about augmentation
 814      *            (target path, childs...)
 815      * @param module
 816      *            current module
 817      * @throws IllegalArgumentException
 818      *             <ul>
 819      *             <li>if <code>augmentPackageName</code> equals null</li>
 820      *             <li>if <code>augSchema</code> equals null</li>
 821      *             </ul>
 822      * @throws IllegalStateException
 823      *             if augment target path is null
 824      */
 825     private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
 826             final Module module) {
 827         checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
 828         checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
 829         checkState(augSchema.getTargetPath() != null,
 830                 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 831
 832         processUsesAugments(augSchema, module);
 833         final SchemaPath targetPath = augSchema.getTargetPath();
 834         SchemaNode targetSchemaNode = null;
 835
 836         targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
 837         if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
 838             if (targetSchemaNode instanceof DerivableSchemaNode) {
 839                 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
 840             }
 841             if (targetSchemaNode == null) {
 842                 throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
 843                         + " in module " + module.getName());
 844             }
 845         }
 846         if (targetSchemaNode == null) {
 847             throw new IllegalArgumentException("augment target not found: " + targetPath);
 848         }
 849
 850         GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
 851         if (targetTypeBuilder == null) {
 852             targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
 853         }
 854         if (targetTypeBuilder == null) {
 855             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 856         }
 857
 858         if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
 859             final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
 860                     targetTypeBuilder.getName());
 861             addRawAugmentGenTypeDefinition(module, augmentPackageName, augmentPackageName, targetType, augSchema);
 862
 863         } else {
 864             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
 865                     (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), null);
 866         }
 867     }
 868
 869     private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
 870             final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
 871         checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
 872         checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
 873         checkState(augSchema.getTargetPath() != null,
 874                 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 875
 876         processUsesAugments(augSchema, module);
 877         final SchemaPath targetPath = augSchema.getTargetPath();
 878         final SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
 879         if (targetSchemaNode == null) {
 880             throw new IllegalArgumentException("augment target not found: " + targetPath);
 881         }
 882
 883         GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
 884         if (targetTypeBuilder == null) {
 885             targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
 886         }
 887         if (targetTypeBuilder == null) {
 888             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 889         }
 890
 891         if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
 892             String packageName = augmentPackageName;
 893             if (usesNodeParent instanceof SchemaNode) {
 894                 packageName = packageNameForAugmentedGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath());
 895             }
 896             addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
 897                     augSchema);
 898         } else {
 899             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
 900                     (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), usesNodeParent);
 901         }
 902     }
 903
 904     /**
 905      * Convenient method to find node added by uses statement.
 906      *
 907      * @param targetPath
 908      *            node path
 909      * @param parentUsesNode
 910      *            parent of uses node
 911      * @return node from its original location in grouping
 912      */
 913     private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
 914         final SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
 915                 .getPathFromRoot());
 916         if (!(targetGrouping instanceof GroupingDefinition)) {
 917             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 918         }
 919
 920         SchemaNode result = targetGrouping;
 921         for (final QName node : targetPath.getPathFromRoot()) {
 922             if (result instanceof DataNodeContainer) {
 923                 final QName resultNode = QName.create(result.getQName().getModule(), node.getLocalName());
 924                 result = ((DataNodeContainer) result).getDataChildByName(resultNode);
 925             } else if (result instanceof ChoiceSchemaNode) {
 926                 result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName());
 927             }
 928         }
 929         if (result == null) {
 930             return null;
 931         }
 932
 933         if (result instanceof DerivableSchemaNode) {
 934             DerivableSchemaNode castedResult = (DerivableSchemaNode) result;
 935             Optional<? extends SchemaNode> originalNode = castedResult
 936                     .getOriginal();
 937             if (castedResult.isAddedByUses() && originalNode.isPresent()) {
 938                 result = originalNode.get();
 939             }
 940         }
 941
 942         if (result instanceof DataSchemaNode) {
 943             DataSchemaNode resultDataSchemaNode = (DataSchemaNode) result;
 944             if (resultDataSchemaNode.isAddedByUses()) {
 945                 // The original node is required, but we have only the copy of
 946                 // the original node.
 947                 // Maybe this indicates a bug in Yang parser.
 948                 throw new IllegalStateException(
 949                         "Failed to generate code for augment in "
 950                                 + parentUsesNode);
 951             } else {
 952                 return resultDataSchemaNode;
 953             }
 954         } else {
 955             throw new IllegalStateException(
 956                     "Target node of uses-augment statement must be DataSchemaNode. Failed to generate code for augment in "
 957                             + parentUsesNode);
 958         }
 959     }
 960
 961     /**
 962      * Returns a generated type builder for an augmentation.
 963      *
 964      * The name of the type builder is equal to the name of augmented node with
 965      * serial number as suffix.
 966      *
 967      * @param module
 968      *            current module
 969      * @param augmentPackageName
 970      *            string with contains the package name to which the augment
 971      *            belongs
 972      * @param basePackageName
 973      *            string with the package name to which the augmented node
 974      *            belongs
 975      * @param targetTypeRef
 976      *            target type
 977      * @param augSchema
 978      *            augmentation schema which contains data about the child nodes
 979      *            and uses of augment
 980      * @return generated type builder for augment
 981      */
 982     private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
 983             final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
 984         Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
 985         if (augmentBuilders == null) {
 986             augmentBuilders = new HashMap<>();
 987             genTypeBuilders.put(augmentPackageName, augmentBuilders);
 988         }
 989         final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
 990
 991         String augTypeName;
 992         if (augIdentifier != null) {
 993             augTypeName = BindingMapping.getClassName(augIdentifier);
 994         } else {
 995             augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 996         }
 997
 998         final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
 999
1000         augTypeBuilder.addImplementsType(DATA_OBJECT);
1001         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
1002         annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
1003         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
1004
1005         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
1006         augmentBuilders.put(augTypeName, augTypeBuilder);
1007
1008         if (!augSchema.getChildNodes().isEmpty()) {
1009             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
1010
1011         }
1012         genCtx.get(module).addAugmentType(augTypeBuilder);
1013         return augTypeBuilder;
1014     }
1015
1016     /**
1017      *
1018      * @param unknownSchemaNodes
1019      * @return nodeParameter of UnknownSchemaNode
1020      */
1021     private static String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
1022         for (final UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
1023             final QName nodeType = unknownSchemaNode.getNodeType();
1024             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
1025                     && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
1026                 return unknownSchemaNode.getNodeParameter();
1027             }
1028         }
1029         return null;
1030     }
1031
1032     /**
1033      * Returns first unique name for the augment generated type builder. The
1034      * generated type builder name for augment consists from name of augmented
1035      * node and serial number of its augmentation.
1036      *
1037      * @param builders
1038      *            map of builders which were created in the package to which the
1039      *            augmentation belongs
1040      * @param genTypeName
1041      *            string with name of augmented node
1042      * @return string with unique name for augmentation builder
1043      */
1044     private static String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
1045         int index = 1;
1046         if (builders != null) {
1047             while (builders.containsKey(genTypeName + index)) {
1048                 index = index + 1;
1049             }
1050         }
1051         return genTypeName + index;
1052     }
1053
1054     /**
1055      * Adds the methods to <code>typeBuilder</code> which represent subnodes of
1056      * node for which <code>typeBuilder</code> was created.
1057      *
1058      * The subnodes aren't mapped to the methods if they are part of grouping or
1059      * augment (in this case are already part of them).
1060      *
1061      * @param module
1062      *            current module
1063      * @param basePackageName
1064      *            string contains the module package name
1065      * @param parent
1066      *            generated type builder which represents any node. The subnodes
1067      *            of this node are added to the <code>typeBuilder</code> as
1068      *            methods. The subnode can be of type leaf, leaf-list, list,
1069      *            container, choice.
1070      * @param childOf
1071      *            parent type
1072      * @param schemaNodes
1073      *            set of data schema nodes which are the children of the node
1074      *            for which <code>typeBuilder</code> was created
1075      * @return generated type builder which is the same builder as input
1076      *         parameter. The getter methods (representing child nodes) could be
1077      *         added to it.
1078      */
1079     private GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
1080             final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
1081         if (schemaNodes != null && parent != null) {
1082             for (final DataSchemaNode schemaNode : schemaNodes) {
1083                 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
1084                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1085                 }
1086             }
1087         }
1088         return parent;
1089     }
1090
1091     /**
1092      * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1093      * node for which <code>typeBuilder</code> was created.
1094      *
1095      * @param module
1096      *            current module
1097      * @param basePackageName
1098      *            string contains the module package name
1099      * @param typeBuilder
1100      *            generated type builder which represents any node. The subnodes
1101      *            of this node are added to the <code>typeBuilder</code> as
1102      *            methods. The subnode can be of type leaf, leaf-list, list,
1103      *            container, choice.
1104      * @param childOf
1105      *            parent type
1106      * @param schemaNodes
1107      *            set of data schema nodes which are the children of the node
1108      *            for which <code>typeBuilder</code> was created
1109      * @return generated type builder which is the same object as the input
1110      *         parameter <code>typeBuilder</code>. The getter method could be
1111      *         added to it.
1112      */
1113     private GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
1114             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
1115             final Iterable<DataSchemaNode> schemaNodes) {
1116         if ((schemaNodes != null) && (typeBuilder != null)) {
1117             for (final DataSchemaNode schemaNode : schemaNodes) {
1118                 if (!schemaNode.isAugmenting()) {
1119                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1120                 }
1121             }
1122         }
1123         return typeBuilder;
1124     }
1125
1126     /**
1127      * Adds to <code>typeBuilder</code> a method which is derived from
1128      * <code>schemaNode</code>.
1129      *
1130      * @param basePackageName
1131      *            string with the module package name
1132      * @param node
1133      *            data schema node which is added to <code>typeBuilder</code> as
1134      *            a method
1135      * @param typeBuilder
1136      *            generated type builder to which is <code>schemaNode</code>
1137      *            added as a method.
1138      * @param childOf
1139      *            parent type
1140      * @param module
1141      *            current module
1142      */
1143     private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
1144             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
1145         if (node != null && typeBuilder != null) {
1146             if (node instanceof LeafSchemaNode) {
1147                 resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node, module);
1148             } else if (node instanceof LeafListSchemaNode) {
1149                 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node,module);
1150             } else if (node instanceof ContainerSchemaNode) {
1151                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
1152             } else if (node instanceof ListSchemaNode) {
1153                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
1154             } else if (node instanceof ChoiceSchemaNode) {
1155                 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) node);
1156             } else {
1157                 // TODO: anyxml not yet supported
1158                 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
1159                         typeBuilder.getFullyQualifiedName());
1160             }
1161         }
1162     }
1163
1164     /**
1165      * Converts <code>choiceNode</code> to the list of generated types for
1166      * choice and its cases.
1167      *
1168      * The package names for choice and for its cases are created as
1169      * concatenation of the module package (<code>basePackageName</code>) and
1170      * names of all parents node.
1171      *
1172      * @param module
1173      *            current module
1174      * @param basePackageName
1175      *            string with the module package name
1176      * @param parent
1177      *            parent type
1178      * @param choiceNode
1179      *            choice node which is mapped to generated type. Also child
1180      *            nodes - cases are mapped to generated types.
1181      * @throws IllegalArgumentException
1182      *             <ul>
1183      *             <li>if <code>basePackageName</code> is null</li>
1184      *             <li>if <code>choiceNode</code> is null</li>
1185      *             </ul>
1186      */
1187     private void choiceToGeneratedType(final Module module, final String basePackageName,
1188             final GeneratedTypeBuilder parent, final ChoiceSchemaNode choiceNode) {
1189         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1190         checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
1191
1192         if (!choiceNode.isAddedByUses()) {
1193             final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
1194             final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1195             constructGetter(parent, choiceNode.getQName().getLocalName(),
1196                     choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
1197             choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
1198             annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
1199             genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
1200             generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
1201         }
1202     }
1203
1204     /**
1205      * Converts <code>caseNodes</code> set to list of corresponding generated
1206      * types.
1207      *
1208      * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1209      * created generated type builder. The package names for the builder is
1210      * created as concatenation of the module package (
1211      * <code>basePackageName</code>) and names of all parents nodes of the
1212      * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1213      * between every case builder and <i>choice</i> type
1214      *
1215      * @param module
1216      *            current module
1217      * @param basePackageName
1218      *            string with the module package name
1219      * @param refChoiceType
1220      *            type which represents superior <i>case</i>
1221      * @param choiceNode
1222      *            choice case node which is mapped to generated type
1223      * @return list of generated types for <code>caseNodes</code>.
1224      * @throws IllegalArgumentException
1225      *             <ul>
1226      *             <li>if <code>basePackageName</code> equals null</li>
1227      *             <li>if <code>refChoiceType</code> equals null</li>
1228      *             <li>if <code>caseNodes</code> equals null</li>
1229      *             </ul>
1230      */
1231     private void generateTypesFromChoiceCases(final Module module, final String basePackageName,
1232             final Type refChoiceType, final ChoiceSchemaNode choiceNode) {
1233         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1234         checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1235         checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1236
1237         final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1238         if (caseNodes == null) {
1239             return;
1240         }
1241
1242         for (final ChoiceCaseNode caseNode : caseNodes) {
1243             if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1244                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1245                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1246                 caseTypeBuilder.addImplementsType(refChoiceType);
1247                 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1248                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1249                 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1250                 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1251                 if (caseChildNodes != null) {
1252                     final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1253
1254                     if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1255                         SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1256
1257                         if (parent instanceof AugmentationSchema) {
1258                             final AugmentationSchema augSchema = (AugmentationSchema) parent;
1259                             final SchemaPath targetPath = augSchema.getTargetPath();
1260                             SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1261                             if (targetSchemaNode instanceof DataSchemaNode
1262                                     && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1263                                 if (targetSchemaNode instanceof DerivableSchemaNode) {
1264                                     targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1265                                 }
1266                                 if (targetSchemaNode == null) {
1267                                     throw new IllegalStateException(
1268                                             "Failed to find target node from grouping for augmentation " + augSchema
1269                                                     + " in module " + module.getName());
1270                                 }
1271                             }
1272                             parent = targetSchemaNode;
1273                         }
1274
1275                         Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1276                                 choiceNodeParentPath);
1277                         GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
1278                         if (childOfType == null) {
1279                             childOfType = findGroupingByPath(parent.getPath());
1280                         }
1281                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
1282                     } else {
1283                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module),
1284                                 caseChildNodes);
1285                     }
1286                }
1287             }
1288             processUsesAugments(caseNode, module);
1289         }
1290     }
1291
1292     /**
1293      * Generates list of generated types for all the cases of a choice which are
1294      * added to the choice through the augment.
1295      *
1296      * @param module
1297      *            current module
1298      * @param basePackageName
1299      *            string contains name of package to which augment belongs. If
1300      *            an augmented choice is from an other package (pcg1) than an
1301      *            augmenting choice (pcg2) then case's of the augmenting choice
1302      *            will belong to pcg2.
1303      * @param targetType
1304      *            Type which represents target choice
1305      * @param targetNode
1306      *            node which represents target choice
1307      * @param augmentedNodes
1308      *            set of choice case nodes for which is checked if are/aren't
1309      *            added to choice through augmentation
1310      * @return list of generated types which represents augmented cases of
1311      *         choice <code>refChoiceType</code>
1312      * @throws IllegalArgumentException
1313      *             <ul>
1314      *             <li>if <code>basePackageName</code> is null</li>
1315      *             <li>if <code>targetType</code> is null</li>
1316      *             <li>if <code>augmentedNodes</code> is null</li>
1317      *             </ul>
1318      */
1319     private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
1320             final Type targetType, final ChoiceSchemaNode targetNode, final Iterable<DataSchemaNode> augmentedNodes,
1321             final DataNodeContainer usesNodeParent) {
1322         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1323         checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
1324         checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
1325
1326         for (final DataSchemaNode caseNode : augmentedNodes) {
1327             if (caseNode != null) {
1328                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1329                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1330                 caseTypeBuilder.addImplementsType(targetType);
1331
1332                 SchemaNode parent;
1333                 final SchemaPath nodeSp = targetNode.getPath();
1334                 parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
1335
1336                 GeneratedTypeBuilder childOfType = null;
1337                 if (parent instanceof Module) {
1338                     childOfType = genCtx.get(parent).getModuleNode();
1339                 } else if (parent instanceof ChoiceCaseNode) {
1340                     childOfType = findCaseByPath(parent.getPath());
1341                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1342                     childOfType = findChildNodeByPath(parent.getPath());
1343                 } else if (parent instanceof GroupingDefinition) {
1344                     childOfType = findGroupingByPath(parent.getPath());
1345                 }
1346
1347                 if (childOfType == null) {
1348                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1349                 }
1350
1351                 ChoiceCaseNode node = null;
1352                 final String caseLocalName = caseNode.getQName().getLocalName();
1353                 if (caseNode instanceof ChoiceCaseNode) {
1354                     node = (ChoiceCaseNode) caseNode;
1355                 } else if (targetNode.getCaseNodeByName(caseLocalName) == null) {
1356                     final String targetNodeLocalName = targetNode.getQName().getLocalName();
1357                     for (DataSchemaNode dataSchemaNode : usesNodeParent.getChildNodes()) {
1358                         if (dataSchemaNode instanceof ChoiceSchemaNode && targetNodeLocalName.equals(dataSchemaNode.getQName
1359                                 ().getLocalName())) {
1360                             node = ((ChoiceSchemaNode) dataSchemaNode).getCaseNodeByName(caseLocalName);
1361                             break;
1362                         }
1363                     }
1364                 } else {
1365                     node = targetNode.getCaseNodeByName(caseLocalName);
1366                 }
1367                 final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
1368                 if (childNodes != null) {
1369                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1370                 }
1371                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1372                 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
1373             }
1374         }
1375     }
1376
1377     private static boolean isInnerType(final LeafSchemaNode leaf, final TypeDefinition<?> type) {
1378         // New parser with encapsulated type
1379         if (leaf.getPath().equals(type.getPath())) {
1380             return true;
1381         }
1382
1383         // Embedded type definition with new parser. Also takes care of the old parser with bits
1384         if (leaf.getPath().equals(type.getPath().getParent())) {
1385             return true;
1386         }
1387
1388         return false;
1389     }
1390
1391     /**
1392      * Converts <code>leaf</code> to the getter method which is added to
1393      * <code>typeBuilder</code>.
1394      *
1395      * @param typeBuilder
1396      *            generated type builder to which is added getter method as
1397      *            <code>leaf</code> mapping
1398      * @param leaf
1399      *            leaf schema node which is mapped as getter method which is
1400      *            added to <code>typeBuilder</code>
1401      * @param module
1402      *            Module in which type was defined
1403      * @return boolean value
1404      *         <ul>
1405      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1406      *         null</li>
1407      *         <li>true - in other cases</li>
1408      *         </ul>
1409      */
1410     private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf, final Module module) {
1411         if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) {
1412             return null;
1413         }
1414
1415         final String leafName = leaf.getQName().getLocalName();
1416         if (leafName == null) {
1417             return null;
1418         }
1419
1420         final Module parentModule = findParentModule(schemaContext, leaf);
1421         Type returnType = null;
1422
1423         final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1424         if (isInnerType(leaf, typeDef)) {
1425             if (typeDef instanceof EnumTypeDefinition) {
1426                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1427                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1428                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
1429                     typeBuilder, module);
1430                 if (enumBuilder != null) {
1431                     returnType = enumBuilder.toInstance(typeBuilder);
1432                 }
1433                 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1434             } else if (typeDef instanceof UnionTypeDefinition) {
1435                 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1436                 if (genTOBuilder != null) {
1437                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1438                     // Store the inner type within the union so that we can find the reference for it
1439                     genCtx.get(module).addInnerTypedefType(typeDef.getPath(), returnType);
1440                 }
1441             } else if (typeDef instanceof BitsTypeDefinition) {
1442                 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1443                 if (genTOBuilder != null) {
1444                     returnType = genTOBuilder.toInstance();
1445                 }
1446             } else {
1447                 // It is constrained version of already declared type (inner declared type exists,
1448                 // onlyfor special cases (Enum, Union, Bits), which were already checked.
1449                 // In order to get proper class we need to look up closest derived type
1450                 // and apply restrictions from leaf type
1451                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1452                 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
1453                         restrictions);
1454             }
1455         } else {
1456             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1457             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1458         }
1459
1460         if (returnType == null) {
1461             return null;
1462         }
1463
1464         if (typeDef instanceof EnumTypeDefinition) {
1465             ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1466         }
1467
1468         String leafDesc = leaf.getDescription();
1469         if (leafDesc == null) {
1470             leafDesc = "";
1471         }
1472
1473         final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType, leaf.getStatus());
1474         processContextRefExtension(leaf, getter, parentModule);
1475         return returnType;
1476     }
1477
1478     private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1479         // Returns DerivedType in case of new parser.
1480         final TypeDefinition<?> baseType = typeDef.getBaseType();
1481         return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1482     }
1483
1484     private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
1485             final Module module) {
1486         for (final UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
1487             final QName nodeType = node.getNodeType();
1488             if ("context-reference".equals(nodeType.getLocalName())) {
1489                 final String nodeParam = node.getNodeParameter();
1490                 IdentitySchemaNode identity = null;
1491                 String basePackageName = null;
1492                 final Iterable<String> splittedElement = COLON_SPLITTER.split(nodeParam);
1493                 final Iterator<String> iterator = splittedElement.iterator();
1494                 final int length = Iterables.size(splittedElement);
1495                 if (length == 1) {
1496                     identity = findIdentityByName(module.getIdentities(), iterator.next());
1497                     basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1498                 } else if (length == 2) {
1499                     final String prefix = iterator.next();
1500                     final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
1501                     if (dependentModule == null) {
1502                         throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
1503                                 + prefix);
1504                     }
1505                     identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
1506                     basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
1507                 } else {
1508                     throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1509                             + nodeParam);
1510                 }
1511                 if (identity == null) {
1512                     throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1513                             + nodeParam);
1514                 }
1515
1516                 final Class<RoutingContext> clazz = RoutingContext.class;
1517                 final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
1518                         clazz.getSimpleName());
1519                 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
1520                 final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
1521                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1522             }
1523         }
1524     }
1525
1526     private static IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
1527         for (final IdentitySchemaNode id : identities) {
1528             if (id.getQName().getLocalName().equals(name)) {
1529                 return id;
1530             }
1531         }
1532         return null;
1533     }
1534
1535     private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
1536         for (final ModuleImport imp : imports) {
1537             if (imp.getPrefix().equals(prefix)) {
1538                 return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
1539             }
1540         }
1541         return null;
1542     }
1543
1544     private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1545             final boolean isReadOnly, final Module module) {
1546         if (leaf != null && toBuilder != null) {
1547             Type returnType;
1548             final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1549             if (typeDef instanceof UnionTypeDefinition) {
1550                 // GeneratedType for this type definition should have be already created
1551                 final QName qname = typeDef.getQName();
1552                 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1553                         qname.getRevision());
1554                 final ModuleContext mc = genCtx.get(unionModule);
1555                 returnType = mc.getTypedefs().get(typeDef.getPath());
1556                 if (returnType == null) {
1557                     // This may still be an inner type, try to find it
1558                     returnType = mc.getInnerType(typeDef.getPath());
1559                 }
1560             } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1561                 // Annonymous enumeration (already generated, since it is inherited via uses).
1562                 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1563                 QName qname = originalLeaf.getQName();
1564                 final Module enumModule =  schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1565                         qname.getRevision());
1566                 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1567             } else {
1568                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1569             }
1570             return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1571         }
1572         return false;
1573     }
1574
1575     /**
1576      * Converts <code>leaf</code> schema node to property of generated TO
1577      * builder.
1578      *
1579      * @param toBuilder
1580      *            generated TO builder to which is <code>leaf</code> added as
1581      *            property
1582      * @param leaf
1583      *            leaf schema node which is added to <code>toBuilder</code> as
1584      *            property
1585      * @param returnType
1586      *            property type
1587      * @param isReadOnly
1588      *            boolean value which says if leaf property is|isn't read only
1589      * @return boolean value
1590      *         <ul>
1591      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1592      *         name equals null or if leaf is added by <i>uses</i>.</li>
1593      *         <li>true - other cases</li>
1594      *         </ul>
1595      */
1596     private static boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1597             final Type returnType, final boolean isReadOnly) {
1598         if (returnType == null) {
1599             return false;
1600         }
1601         final String leafName = leaf.getQName().getLocalName();
1602         final String leafDesc = encodeAngleBrackets(leaf.getDescription());
1603         final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(BindingMapping.getPropertyName(leafName));
1604         propBuilder.setReadOnly(isReadOnly);
1605         propBuilder.setReturnType(returnType);
1606         propBuilder.setComment(leafDesc);
1607         toBuilder.addEqualsIdentity(propBuilder);
1608         toBuilder.addHashIdentity(propBuilder);
1609         toBuilder.addToStringProperty(propBuilder);
1610         return true;
1611     }
1612
1613     /**
1614      * Converts <code>node</code> leaf list schema node to getter method of
1615      * <code>typeBuilder</code>.
1616      *
1617      * @param typeBuilder
1618      *            generated type builder to which is <code>node</code> added as
1619      *            getter method
1620      * @param node
1621      *            leaf list schema node which is added to
1622      *            <code>typeBuilder</code> as getter method
1623      * @param module module
1624      * @return boolean value
1625      *         <ul>
1626      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,
1627      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1628      *         <li>false - other cases</li>
1629      *         </ul>
1630      */
1631     private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node, final Module module) {
1632         if (node == null || typeBuilder == null || node.isAddedByUses()) {
1633             return false;
1634         }
1635
1636         final QName nodeName = node.getQName();
1637
1638         final TypeDefinition<?> typeDef = node.getType();
1639         final Module parentModule = findParentModule(schemaContext, node);
1640
1641         Type returnType = null;
1642         if (typeDef.getBaseType() == null) {
1643             if (typeDef instanceof EnumTypeDefinition) {
1644                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1645                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1646                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
1647                     typeBuilder,module);
1648                 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
1649                 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1650             } else if (typeDef instanceof UnionTypeDefinition) {
1651                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1652                 if (genTOBuilder != null) {
1653                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1654                 }
1655             } else if (typeDef instanceof BitsTypeDefinition) {
1656                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1657                 returnType = genTOBuilder.toInstance();
1658             } else {
1659                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1660                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1661             }
1662         } else {
1663             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1664             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1665         }
1666
1667         final ParameterizedType listType = Types.listTypeFor(returnType);
1668         constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
1669         return true;
1670     }
1671
1672     private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
1673             final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
1674         final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
1675                 genTOBuilder.getName());
1676         final String typedefDescription = encodeAngleBrackets(typeDef.getDescription());
1677
1678         returnType.setDescription(typedefDescription);
1679         returnType.setReference(typeDef.getReference());
1680         returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
1681         returnType.setModuleName(parentModule.getName());
1682
1683         genTOBuilder.setTypedef(true);
1684         genTOBuilder.setIsUnion(true);
1685         TypeProviderImpl.addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1686
1687
1688
1689         final GeneratedTOBuilder unionBuilder = createUnionBuilder(genTOBuilder,typeBuilder);
1690
1691
1692         final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1693         method.setReturnType(returnType);
1694         method.addParameter(Types.STRING, "defaultValue");
1695         method.setAccessModifier(AccessModifier.PUBLIC);
1696         method.setStatic(true);
1697
1698         final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
1699         if (types == null) {
1700             ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
1701                     Sets.newHashSet(unionBuilder.toInstance()));
1702         } else {
1703             types.add(unionBuilder.toInstance());
1704         }
1705         return returnType.toInstance();
1706     }
1707
1708     private static GeneratedTOBuilder createUnionBuilder(final GeneratedTOBuilder genTOBuilder, final GeneratedTypeBuilder typeBuilder) {
1709         final String outerCls = Types.getOuterClassName(genTOBuilder);
1710         final StringBuilder name;
1711         if (outerCls != null) {
1712             name = new StringBuilder(outerCls);
1713         } else {
1714             name = new StringBuilder();
1715         }
1716         name.append(genTOBuilder.getName());
1717         name.append("Builder");
1718         final GeneratedTOBuilderImpl unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),name.toString());
1719         unionBuilder.setIsUnionBuilder(true);
1720         return unionBuilder;
1721     }
1722
1723     private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1724             final Module module) {
1725         return addDefaultInterfaceDefinition(packageName, schemaNode, null, module);
1726     }
1727
1728     /**
1729      * Instantiates generated type builder with <code>packageName</code> and
1730      * <code>schemaNode</code>.
1731      *
1732      * The new builder always implements
1733      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br>
1734      * If <code>schemaNode</code> is instance of GroupingDefinition it also
1735      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1736      * Augmentable}.<br>
1737      * If <code>schemaNode</code> is instance of
1738      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1739      * DataNodeContainer} it can also implement nodes which are specified in
1740      * <i>uses</i>.
1741      *
1742      * @param packageName
1743      *            string with the name of the package to which
1744      *            <code>schemaNode</code> belongs.
1745      * @param schemaNode
1746      *            schema node for which is created generated type builder
1747      * @param parent
1748      *            parent type (can be null)
1749      * @return generated type builder <code>schemaNode</code>
1750      */
1751     private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1752             final Type parent, final Module module) {
1753         final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
1754         if (parent == null) {
1755             it.addImplementsType(DATA_OBJECT);
1756         } else {
1757             it.addImplementsType(BindingTypes.childOf(parent));
1758         }
1759         if (!(schemaNode instanceof GroupingDefinition)) {
1760             it.addImplementsType(augmentable(it));
1761         }
1762
1763         if (schemaNode instanceof DataNodeContainer) {
1764             groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings());
1765             addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
1766         }
1767
1768         return it;
1769     }
1770
1771     /**
1772      * Wraps the calling of the same overloaded method.
1773      *
1774      * @param packageName
1775      *            string with the package name to which returning generated type
1776      *            builder belongs
1777      * @param schemaNode
1778      *            schema node which provide data about the schema node name
1779      * @return generated type builder for <code>schemaNode</code>
1780      */
1781     private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1782         return addRawInterfaceDefinition(packageName, schemaNode, "");
1783     }
1784
1785     /**
1786      * Returns reference to generated type builder for specified
1787      * <code>schemaNode</code> with <code>packageName</code>.
1788      *
1789      * Firstly the generated type builder is searched in
1790      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1791      * found it is created and added to <code>genTypeBuilders</code>.
1792      *
1793      * @param packageName
1794      *            string with the package name to which returning generated type
1795      *            builder belongs
1796      * @param schemaNode
1797      *            schema node which provide data about the schema node name
1798      * @param prefix
1799      *            return type name prefix
1800      * @return generated type builder for <code>schemaNode</code>
1801      * @throws IllegalArgumentException
1802      *             <ul>
1803      *             <li>if <code>schemaNode</code> is null</li>
1804      *             <li>if <code>packageName</code> is null</li>
1805      *             <li>if QName of schema node is null</li>
1806      *             <li>if schemaNode name is null</li>
1807      *             </ul>
1808      *
1809      */
1810     private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1811             final String prefix) {
1812         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1813         checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
1814         checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
1815         final String schemaNodeName = schemaNode.getQName().getLocalName();
1816         checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
1817
1818         String genTypeName;
1819         if (prefix == null) {
1820             genTypeName = BindingMapping.getClassName(schemaNodeName);
1821         } else {
1822             genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1823         }
1824
1825         // FIXME: Validation of name conflict
1826         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1827         final Module module = findParentModule(schemaContext, schemaNode);
1828         qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
1829         newType.addComment(schemaNode.getDescription());
1830         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
1831         newType.setReference(schemaNode.getReference());
1832         newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
1833         newType.setModuleName(module.getName());
1834
1835         if (!genTypeBuilders.containsKey(packageName)) {
1836             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
1837             builders.put(genTypeName, newType);
1838             genTypeBuilders.put(packageName, builders);
1839         } else {
1840             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1841             if (!builders.containsKey(genTypeName)) {
1842                 builders.put(genTypeName, newType);
1843             }
1844         }
1845         return newType;
1846     }
1847
1848     /**
1849      * Creates the name of the getter method name from <code>localName</code>.
1850      *
1851      * @param localName
1852      *            string with the name of the getter method
1853      * @param returnType
1854      *            return type
1855      * @return string with the name of the getter method for
1856      *         <code>methodName</code> in JAVA method format
1857      */
1858     public static String getterMethodName(final String localName, final Type returnType) {
1859         final StringBuilder method = new StringBuilder();
1860         if (BOOLEAN.equals(returnType)) {
1861             method.append("is");
1862         } else {
1863             method.append("get");
1864         }
1865         final String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
1866         method.append(name);
1867         return method.toString();
1868     }
1869
1870     /**
1871      * Created a method signature builder as part of
1872      * <code>interfaceBuilder</code>.
1873      *
1874      * The method signature builder is created for the getter method of
1875      * <code>schemaNodeName</code>. Also <code>comment</code> and
1876      * <code>returnType</code> information are added to the builder.
1877      *
1878      * @param interfaceBuilder
1879      *            generated type builder for which the getter method should be
1880      *            created
1881      * @param schemaNodeName
1882      *            string with schema node name. The name will be the part of the
1883      *            getter method name.
1884      * @param comment
1885      *            string with comment for the getter method
1886      * @param returnType
1887      *            type which represents the return type of the getter method
1888      * @param status
1889      *            status from yang file, for deprecated annotation
1890      * @return method signature builder which represents the getter method of
1891      *         <code>interfaceBuilder</code>
1892      */
1893     private static MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
1894             final String schemaNodeName, final String comment, final Type returnType, final Status status) {
1895         final MethodSignatureBuilder getMethod = interfaceBuilder
1896                 .addMethod(getterMethodName(schemaNodeName, returnType));
1897         if (status == Status.DEPRECATED) {
1898             getMethod.addAnnotation("", "Deprecated");
1899         }
1900         getMethod.setComment(encodeAngleBrackets(comment));
1901         getMethod.setReturnType(returnType);
1902         return getMethod;
1903     }
1904
1905     /**
1906      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1907      * or to <code>genTOBuilder</code> as property.
1908      *
1909      * @param basePackageName
1910      *            string contains the module package name
1911      * @param schemaNode
1912      *            data schema node which should be added as getter method to
1913      *            <code>typeBuilder</code> or as a property to
1914      *            <code>genTOBuilder</code> if is part of the list key
1915      * @param typeBuilder
1916      *            generated type builder for the list schema node
1917      * @param genTOBuilder
1918      *            generated TO builder for the list keys
1919      * @param listKeys
1920      *            list of string which contains names of the list keys
1921      * @param module
1922      *            current module
1923      * @throws IllegalArgumentException
1924      *             <ul>
1925      *             <li>if <code>schemaNode</code> equals null</li>
1926      *             <li>if <code>typeBuilder</code> equals null</li>
1927      *             </ul>
1928      */
1929     private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
1930             final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
1931             final Module module) {
1932         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1933         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1934
1935         if (schemaNode instanceof LeafSchemaNode) {
1936             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1937             final String leafName = leaf.getQName().getLocalName();
1938             Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf, module);
1939             if (listKeys.contains(leafName)) {
1940                 if (type == null) {
1941                     resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
1942                 } else {
1943                     resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1944                 }
1945             }
1946         } else if (!schemaNode.isAddedByUses()) {
1947             if (schemaNode instanceof LeafListSchemaNode) {
1948                 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode, module);
1949             } else if (schemaNode instanceof ContainerSchemaNode) {
1950                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
1951             } else if (schemaNode instanceof ChoiceSchemaNode) {
1952                 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) schemaNode);
1953             } else if (schemaNode instanceof ListSchemaNode) {
1954                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
1955             }
1956         }
1957     }
1958
1959     private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
1960             final GeneratedTOBuilder genTOBuilder) {
1961         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1962
1963         if (genTOBuilder != null) {
1964             final GeneratedTransferObject genTO = genTOBuilder.toInstance();
1965             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
1966             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
1967         }
1968     }
1969
1970     /**
1971      * Selects the names of the list keys from <code>list</code> and returns
1972      * them as the list of the strings
1973      *
1974      * @param list
1975      *            of string with names of the list keys
1976      * @return list of string which represents names of the list keys. If the
1977      *         <code>list</code> contains no keys then the empty list is
1978      *         returned.
1979      */
1980     private static List<String> listKeys(final ListSchemaNode list) {
1981         final List<String> listKeys = new ArrayList<>();
1982
1983         final List<QName> keyDefinition = list.getKeyDefinition();
1984         if (keyDefinition != null) {
1985             for (final QName keyDef : keyDefinition) {
1986                 listKeys.add(keyDef.getLocalName());
1987             }
1988         }
1989         return listKeys;
1990     }
1991
1992     /**
1993      * Generates for the <code>list</code> which contains any list keys special
1994      * generated TO builder.
1995      *
1996      * @param packageName
1997      *            string with package name to which the list belongs
1998      * @param list
1999      *            list schema node which is source of data about the list name
2000      * @return generated TO builder which represents the keys of the
2001      *         <code>list</code> or null if <code>list</code> is null or list of
2002      *         key definitions is null or empty.
2003      */
2004     private static GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
2005         GeneratedTOBuilder genTOBuilder = null;
2006         if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
2007             final String listName = list.getQName().getLocalName() + "Key";
2008             final String genTOName = BindingMapping.getClassName(listName);
2009             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
2010         }
2011         return genTOBuilder;
2012     }
2013
2014     /**
2015      * Builds generated TO builders for <code>typeDef</code> of type
2016      * {@link UnionTypeDefinition} or {@link BitsTypeDefinition} which are
2017      * also added to <code>typeBuilder</code> as enclosing transfer object.
2018      *
2019      * If more then one generated TO builder is created for enclosing then all
2020      * of the generated TO builders are added to <code>typeBuilder</code> as
2021      * enclosing transfer objects.
2022      *
2023      * @param typeDef
2024      *            type definition which can be of type <code>UnionType</code> or
2025      *            <code>BitsTypeDefinition</code>
2026      * @param typeBuilder
2027      *            generated type builder to which is added generated TO created
2028      *            from <code>typeDef</code>
2029      * @param leaf
2030      *            string with name for generated TO builder
2031      * @param parentModule
2032      *            parent module
2033      * @return generated TO builder for <code>typeDef</code>
2034      */
2035     private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
2036             final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
2037         final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
2038         final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
2039         final String packageName = typeBuilder.getFullyQualifiedName();
2040         if (typeDef instanceof UnionTypeDefinition) {
2041             final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
2042                     .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
2043                             classNameFromLeaf, leaf);
2044             genTOBuilders.addAll(types);
2045
2046             GeneratedTOBuilder resultTOBuilder;
2047             if (types.isEmpty()) {
2048                 throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef);
2049             }
2050             resultTOBuilder = types.remove(0);
2051             for (final GeneratedTOBuilder genTOBuilder : types) {
2052                 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
2053             }
2054
2055             final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
2056             genPropBuilder.setReturnType(Types.CHAR_ARRAY);
2057             resultTOBuilder.addEqualsIdentity(genPropBuilder);
2058             resultTOBuilder.addHashIdentity(genPropBuilder);
2059             resultTOBuilder.addToStringProperty(genPropBuilder);
2060
2061         } else if (typeDef instanceof BitsTypeDefinition) {
2062             genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
2063                     packageName, typeDef, classNameFromLeaf, parentModule.getName()));
2064         }
2065         if (!genTOBuilders.isEmpty()) {
2066             for (final GeneratedTOBuilder genTOBuilder : genTOBuilders) {
2067                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
2068             }
2069             return genTOBuilders.get(0);
2070         }
2071         return null;
2072
2073     }
2074
2075     /**
2076      * Adds the implemented types to type builder.
2077      *
2078      * The method passes through the list of <i>uses</i> in
2079      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
2080      * generated type from {@link ModuleContext#groupings
2081      * allGroupings} which is added as <i>implements type</i> to
2082      * <code>builder</code>
2083      *
2084      * @param dataNodeContainer
2085      *            element which contains the list of used YANG groupings
2086      * @param builder
2087      *            builder to which are added implemented types according to
2088      *            <code>dataNodeContainer</code>
2089      * @return generated type builder with all implemented types
2090      */
2091     private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
2092             final GeneratedTypeBuilder builder) {
2093         for (final UsesNode usesNode : dataNodeContainer.getUses()) {
2094             final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
2095             if (genType == null) {
2096                 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
2097                         + builder.getName());
2098             }
2099
2100             builder.addImplementsType(genType);
2101         }
2102         return builder;
2103     }
2104
2105     private static boolean isNullOrEmpty(final Collection<?> list) {
2106         return list == null || list.isEmpty();
2107     }
2108
2109     private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName) {
2110         final StringBuilder sb = new StringBuilder();
2111
2112         if (!isNullOrEmpty(schemaNodes)) {
2113             final SchemaNode node = schemaNodes.iterator().next();
2114
2115             if (node instanceof RpcDefinition) {
2116                 sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
2117             } else if (node instanceof NotificationDefinition) {
2118                 sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
2119             }
2120         }
2121         sb.append(NEW_LINE);
2122
2123         if (verboseClassComments) {
2124             sb.append("<pre>");
2125             sb.append(NEW_LINE);
2126             sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNodes)));
2127             sb.append("</pre>");
2128             sb.append(NEW_LINE);
2129         }
2130
2131         return replaceAllIllegalChars(sb);
2132     }
2133
2134     private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
2135         final StringBuilder sb = new StringBuilder();
2136         final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription());
2137         final String formattedDescription = YangTextTemplate.formatToParagraph(nodeDescription, 0);
2138
2139         if (!Strings.isNullOrEmpty(formattedDescription)) {
2140             sb.append(formattedDescription);
2141             sb.append(NEW_LINE);
2142         }
2143
2144         if (verboseClassComments) {
2145             final Module module = findParentModule(schemaContext, schemaNode);
2146             final StringBuilder linkToBuilderClass = new StringBuilder();
2147             final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
2148             final String className = namespace[namespace.length - 1];
2149
2150             if (hasBuilderClass(schemaNode)) {
2151                 linkToBuilderClass.append(className);
2152                 linkToBuilderClass.append("Builder");
2153             }
2154
2155             sb.append("<p>");
2156             sb.append("This class represents the following YANG schema fragment defined in module <b>");
2157             sb.append(module.getName());
2158             sb.append("</b>");
2159             sb.append(NEW_LINE);
2160             sb.append("<pre>");
2161             sb.append(NEW_LINE);
2162             sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNode)));
2163             sb.append("</pre>");
2164             sb.append(NEW_LINE);
2165             sb.append("The schema path to identify an instance is");
2166             sb.append(NEW_LINE);
2167             sb.append("<i>");
2168             sb.append(YangTextTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
2169             sb.append("</i>");
2170             sb.append(NEW_LINE);
2171
2172             if (hasBuilderClass(schemaNode)) {
2173                 sb.append(NEW_LINE);
2174                 sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
2175                 sb.append(NEW_LINE);
2176                 sb.append("@see ");
2177                 sb.append(linkToBuilderClass);
2178                 sb.append(NEW_LINE);
2179                 if (schemaNode instanceof ListSchemaNode) {
2180                     final List<QName> keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition();
2181                     if (keyDef != null && !keyDef.isEmpty()) {
2182                         sb.append("@see ");
2183                         sb.append(className);
2184                         sb.append("Key");
2185                     }
2186                     sb.append(NEW_LINE);
2187                 }
2188             }
2189         }
2190
2191         return replaceAllIllegalChars(sb);
2192     }
2193
2194     private static boolean hasBuilderClass(final SchemaNode schemaNode) {
2195         if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
2196                 schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
2197             return true;
2198         }
2199         return false;
2200     }
2201
2202     private String createDescription(final Module module) {
2203         final StringBuilder sb = new StringBuilder();
2204         final String moduleDescription = encodeAngleBrackets(module.getDescription());
2205         final String formattedDescription = YangTextTemplate.formatToParagraph(moduleDescription, 0);
2206
2207         if (!Strings.isNullOrEmpty(formattedDescription)) {
2208             sb.append(formattedDescription);
2209             sb.append(NEW_LINE);
2210         }
2211
2212         if (verboseClassComments) {
2213             sb.append("<p>");
2214             sb.append("This class represents the following YANG schema fragment defined in module <b>");
2215             sb.append(module.getName());
2216             sb.append("</b>");
2217             sb.append(NEW_LINE);
2218             sb.append("<pre>");
2219             sb.append(NEW_LINE);
2220             sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(module)));
2221             sb.append("</pre>");
2222         }
2223
2224         return replaceAllIllegalChars(sb);
2225     }
2226
2227     private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
2228         for (final ModuleContext ctx : genCtx.values()) {
2229             final GeneratedTypeBuilder result = ctx.getChildNode(path);
2230             if (result != null) {
2231                 return result;
2232             }
2233         }
2234         return null;
2235     }
2236
2237     private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
2238         for (final ModuleContext ctx : genCtx.values()) {
2239             final GeneratedTypeBuilder result = ctx.getGrouping(path);
2240             if (result != null) {
2241                 return result;
2242             }
2243         }
2244         return null;
2245     }
2246
2247     private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
2248         for (final ModuleContext ctx : genCtx.values()) {
2249             final GeneratedTypeBuilder result = ctx.getCase(path);
2250             if (result != null) {
2251                 return result;
2252             }
2253         }
2254         return null;
2255     }
2256
2257     public Map<Module, ModuleContext> getModuleContexts() {
2258         return genCtx;
2259     }
2260
2261     @VisibleForTesting
2262     static String replaceAllIllegalChars(final StringBuilder stringBuilder){
2263         final String ret = UNICODE_CHAR_PATTERN.matcher(stringBuilder).replaceAll("\\\\\\\\u");
2264         return ret.isEmpty() ? "" : ret;
2265     }
2266
2267     private static void annotateDeprecatedIfNecessary(final Status status, final GeneratedTypeBuilder builder) {
2268         if (status == Status.DEPRECATED) {
2269             builder.addAnnotation("", "Deprecated");
2270         }
2271     }
2272 }