opendaylight/sal/yang-prototype/code-generator/yang-model-parser-api/src/main/java/org/opendaylight/controller/yang/model/parser/api/YangModelParser.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.controller.yang.model.parser.api;
   9
  10 import java.io.File;
  11 import java.io.InputStream;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Set;
  15
  16 import org.opendaylight.controller.yang.model.api.Module;
  17 import org.opendaylight.controller.yang.model.api.SchemaContext;
  18 import org.opendaylight.controller.yang.model.api.type.UnknownTypeDefinition;
  19
  20 /**
  21  * Yang Model Parser interface is designed for parsing yang models and convert
  22  * the information to Data Schema Tree.
  23  *
  24  */
  25 public interface YangModelParser {
  26
  27     /**
  28      * Parse one or more Yang model files and return the definitions of Yang
  29      * modules defined in *.yang files; <br>
  30      * This method SHOULD be used if user need to parse multiple yang models
  31      * that are referenced either through import or include statements.
  32      *
  33      * @param yangFiles
  34      *            yang files to parse
  35      * @return Set of Yang Modules
  36      */
  37     Set<Module> parseYangModels(final List<File> yangFiles);
  38
  39     /**
  40      * Parse one or more Yang model files and return the definitions of Yang
  41      * modules defined in *.yang files. <br>
  42      * This method SHOULD be used if user has already parsed context and need to
  43      * parse additinal yang models which can have dependencies on models in this
  44      * context.
  45      *
  46      * @param yangFiles
  47      *            yang files to parse
  48      * @param context
  49      *            SchemaContext containing already parsed yang models
  50      * @return Set of Yang Modules
  51      */
  52     Set<Module> parseYangModels(final List<File> yangFiles, final SchemaContext context);
  53
  54     /**
  55      * Equivalent to {@link #parseYangModels(List)} that returns parsed modules
  56      * mapped to Files from which they were parsed.
  57      *
  58      * @param yangFiles
  59      *            yang files to parse
  60      * @return Map of Yang Modules
  61      */
  62     Map<File, Module> parseYangModelsMapped(final List<File> yangFiles);
  63
  64     /**
  65      * Parse one or more Yang model streams and return the definitions of Yang
  66      * modules defined in *.yang files; <br>
  67      * This method SHOULD be used if user need to parse multiple yang models
  68      * that are referenced either through import or include statements.
  69      *
  70      * @param yangModelStreams
  71      *            yang streams to parse
  72      * @return Set of Yang Modules
  73      */
  74     Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams);
  75
  76     /**
  77      * Parse one or more Yang model streams and return the definitions of Yang
  78      * modules defined in *.yang files. <br>
  79      * This method SHOULD be used if user has already parsed context and need to
  80      * parse additinal yang models which can have dependencies on models in this
  81      * context.
  82      *
  83      * @param yangModelStreams
  84      *            yang streams to parse
  85      * @param context
  86      *            SchemaContext containing already parsed yang models
  87      * @return Set of Yang Modules
  88      */
  89     Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams, final SchemaContext context);
  90
  91     /**
  92      * Equivalent to {@link #parseYangModels(List)} that returns parsed modules
  93      * mapped to IputStreams from which they were parsed.
  94      *
  95      * @param yangModelStreams
  96      *            yang streams to parse
  97      * @return Map of Yang Modules
  98      */
  99     Map<InputStream, Module> parseYangModelsFromStreamsMapped(final List<InputStream> yangModelStreams);
 100
 101     /**
 102      * Creates {@link SchemaContext} from specified Modules. The modules SHOULD
 103      * not contain any unresolved Schema Nodes or Type Definitions. By
 104      * unresolved Schema Nodes or Type Definitions we mean that the Module
 105      * should not contain ANY Schema Nodes that contains
 106      * {@link UnknownTypeDefinition} and all dependencies although via import or
 107      * include definitions are resolved.
 108      *
 109      * @param modules
 110      *            Set of Yang Modules
 111      * @return Schema Context instance constructed from whole Set of Modules.
 112      */
 113     SchemaContext resolveSchemaContext(final Set<Module> modules);
 114 }