binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/generator/api/BindingRuntimeGenerator.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.generator.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  12
  13 /**
  14  * Runtime equivalent of {@link BindingGenerator}. It generates equivalent type information, but does not include
  15  * metadata not required at runtime, such as comments, references and similar.
  16  */
  17 @Beta
  18 public interface BindingRuntimeGenerator {
  19     /**
  20      * Generate Type mapping from specified {@link SchemaContext} for the specified subset of modules. The SchemaContext
  21      * MUST contain all of the sub modules otherwise the there is no guarantee that result List of Generated Types will
  22      * contain correct Generated Types.
  23      *
  24      * @param context Schema Context
  25      * @return Generated type mapping.
  26      */
  27     BindingRuntimeTypes generateTypeMapping(SchemaContext context);
  28 }