binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/api/BindingGenerator.java

   1 /*
   2  * Copyright (c) 2017 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
   9 package org.opendaylight.mdsal.binding.javav2.generator.api;
  10
  11 import com.google.common.annotations.Beta;
  12 import java.util.List;
  13 import java.util.Set;
  14 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  15 import org.opendaylight.yangtools.yang.model.api.Module;
  16 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  17
  18 /**
  19  *
  20  * Transforms Schema Context to Generated types.
  21  *
  22  */
  23 @Beta
  24 public interface BindingGenerator {
  25
  26     /**
  27      * Generate Types from whole Schema Context. <br>
  28      * The method will return List of All Generated Types that could be
  29      * Generated from Schema Context.
  30      *
  31      *
  32      * @param context
  33      *            Schema Context
  34      * @return List of Generated Types
  35      *
  36      * @see SchemaContext
  37      */
  38     List<Type> generateTypes(SchemaContext context);
  39
  40     /**
  41      * Generate Types from Schema Context restricted by sub set of specified
  42      * Modules. The Schema Context MUST contain all of the sub modules otherwise
  43      * there is no guarantee that result List of Generated Types will
  44      * contain correct Generated Types.
  45      *
  46      * @param context
  47      *            Schema Context
  48      * @param modules
  49      *            Sub Set of Modules
  50      * @return List of Generated Types restricted by sub set of Modules
  51      *
  52      * @see Module
  53      * @see SchemaContext
  54      */
  55     List<Type> generateTypes(SchemaContext context, Set<Module> modules);
  56 }