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