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