binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/binding/runtime/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.binding.runtime.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
  13 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  14
  15 /**
  16  * Runtime equivalent of {@link BindingGenerator}. It generates equivalent type information, but does not include
  17  * metadata not required at runtime, such as comments, references and similar.
  18  */
  19 @Beta
  20 @NonNullByDefault
  21 public interface BindingRuntimeGenerator {
  22     /**
  23      * Generate Type mapping from specified {@link SchemaContext} for the specified subset of modules. The SchemaContext
  24      * MUST contain all of the sub modules otherwise the there is no guarantee that result List of Generated Types will
  25      * contain correct Generated Types.
  26      *
  27      * @param context Schema Context
  28      * @return Generated type mapping.
  29      */
  30     BindingRuntimeTypes generateTypeMapping(SchemaContext context);
  31 }