+++ /dev/null
-/*
- * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.mdsal.binding.javav2.generator.impl;
-
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.annotations.Beta;
-import com.google.common.base.Preconditions;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import org.opendaylight.mdsal.binding.javav2.generator.api.BindingGenerator;
-import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
-import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
-import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
-import org.opendaylight.mdsal.binding.javav2.model.api.Type;
-import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.util.ModuleDependencySort;
-
-/**
- * Main class for Binding generator v2. Provides transformation of Schema Context to
- * generated transfer objects. Process is accompanied with Twirl templates to generate
- * particular Javadoc for related YANG elements.
- */
-@Beta
-public class BindingGeneratorImpl implements BindingGenerator {
-
- /**
- * When set to true, generated classes will include Javadoc comments
- * which are useful for users.
- */
- private final boolean verboseClassComments;
-
- /**
- * Outer key represents the package name. Outer value represents map of all
- * builders in the same package. Inner key represents the schema node name
- * (in JAVA class/interface name format). Inner value represents instance of
- * builder for schema node specified in key part.
- */
- //TODO: convert it to local variable eventually
- private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders = new HashMap<>();
-
- private Map<Module, ModuleContext> genCtx = new HashMap<>();
-
- /**
- * Provide methods for converting YANG types to JAVA types.
- */
- private TypeProvider typeProvider;
-
- /**
- * Creates a new binding generator v2.
- *
- * @param verboseClassComments generate verbose comments
- */
- public BindingGeneratorImpl(final boolean verboseClassComments) {
- this.verboseClassComments = verboseClassComments;
- }
-
- /**
- * Resolves generated types from <code>context</code> schema nodes of all modules.
- *
- * <p>
- * Generated types are created for modules, groupings, types, containers, lists, choices, augments, rpcs,
- * notification, identities.
- *
- * @param context schema context which contains data about all schema nodes saved in modules
- * @return list of types (usually <code>GeneratedType</code> <code>GeneratedTransferObject</code>which are generated
- * from <code>context</code> data.
- * @throws IllegalArgumentException if arg <code>context</code> is null
- * @throws IllegalStateException if <code>context</code> contain no modules
- */
- @Override
- public List<Type> generateTypes(final SchemaContext context) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL.");
- Preconditions.checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
- final Set<Module> modules = context.getModules();
- return generateTypes(context, modules);
- }
-
- /**
- * Resolves generated types from <code>context</code> schema nodes only for
- * modules specified in <code>modules</code>
- *
- * <p>
- * Generated types are created for modules, groupings, types, containers,
- * lists, choices, augments, rpcs, notification, identities.
- *
- * @param context
- * schema context which contains data about all schema nodes
- * saved in modules
- * @param modules
- * set of modules for which schema nodes should be generated
- * types
- * @return list of types (usually <code>GeneratedType</code> or
- * <code>GeneratedTransferObject</code>) which:
- * <ul>
- * <li>are generated from <code>context</code> schema nodes and</li>
- * <li>are also part of some of the module in <code>modules</code>
- * set.</li>
- * </ul>
- * @throws IllegalArgumentException
- * <ul>
- * <li>if arg <code>context</code> is null or</li>
- * <li>if arg <code>modules</code> is null</li>
- * </ul>
- * @throws IllegalStateException
- * if <code>context</code> contain no modules
- */
- @Override
- public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL.");
- Preconditions.checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
- Preconditions.checkArgument(modules != null, "Set of Modules cannot be NULL.");
-
- this.typeProvider = new TypeProviderImpl(context);
- final List<Module> contextModules = ModuleDependencySort.sort(context.getModules());
- this.genTypeBuilders = new HashMap<>();
-
- for (final Module contextModule : contextModules) {
- this.genCtx = ModuleToGenType.generate(contextModule, this.genTypeBuilders, context, this.typeProvider,
- this.genCtx, this.verboseClassComments);
- this.genCtx.get(contextModule).cleanPackagesMap();
- }
- for (final Module contextModule : contextModules) {
- this.genCtx = AugmentToGenType.generate(contextModule, context, this.typeProvider, this.genCtx,
- this.genTypeBuilders, this.verboseClassComments);
- this.genCtx.get(contextModule).cleanPackagesMap();
- }
-
- final List<Type> filteredGenTypes = new ArrayList<>();
- for (final Module m : modules) {
- final ModuleContext ctx = requireNonNull(this.genCtx.get(m),
- () -> "Module context not found for module " + m);
- filteredGenTypes.addAll(ctx.getGeneratedTypes());
- final Set<Type> additionalTypes = ((TypeProviderImpl) this.typeProvider).getAdditionalTypes().get(m);
- if (additionalTypes != null) {
- filteredGenTypes.addAll(additionalTypes);
- }
- }
-
- return filteredGenTypes;
- }
-
- /**
- * Return module contexts from generated types according to context.
- *
- * @param schemaContext
- * - for generating types
- * @return module contexts
- */
- public Map<Module, ModuleContext> getModuleContexts(final SchemaContext schemaContext) {
- generateTypes(schemaContext);
- return this.genCtx;
- }
-}
Code Review / mdsal.git / blobdiff