2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.parser.api;
10 import com.google.common.annotations.Beta;
11 import com.google.common.collect.SetMultimap;
12 import java.io.IOException;
13 import java.util.Collection;
14 import java.util.List;
17 import javax.annotation.concurrent.NotThreadSafe;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.common.QNameModule;
21 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
27 * Configurable single-use YANG parser. Each instance can be configured to use a different set of models after
28 * which it is built. Models once added cannot be removed.
30 * @author Robert Varga
34 public interface YangParser {
36 * Return enumeration of concrete types of {@link SchemaSourceRepresentation} parsers created from this factory
37 * support. Users can use this information prepare the source they have to a representation which will be accepted
40 * @return Enumeration of supported schema source representations.
42 Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
45 * Return the set of all YANG statements semantically supported by this parser instance.
47 * @return Set of all YANG statements semantically supported by this parser instance.
49 Set<QName> supportedStatements();
52 * Add main source. All main sources are present in resulting SchemaContext.
54 * @param source which should be added into main sources
55 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
56 * @throws IOException when an IO error occurs
57 * @throws IllegalArgumentException if the representation is not supported
59 YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
62 * Add main sources. All main sources are present in resulting SchemaContext.
64 * @param sources which should be added into main sources
65 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
66 * @throws IOException when an IO error occurs
67 * @throws IllegalArgumentException if the representation is not supported
69 default YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
70 YangSyntaxErrorException {
71 for (SchemaSourceRepresentation source : sources) {
77 default YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources) throws IOException,
78 YangSyntaxErrorException {
79 for (SchemaSourceRepresentation source : sources) {
85 YangParser addLibSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
88 * Add library sources. Only library sources required by main sources are present in resulting SchemaContext.
89 * Any other library sources are ignored and this also applies to error reporting.
92 * Note: Library sources are not supported in semantic version mode currently.
94 * @param sources YANG sources which should be added into library sources
95 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
96 * @throws IOException when an IO error occurs
97 * @throws IllegalArgumentException if the representation is not supported
99 default YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
100 YangSyntaxErrorException {
101 for (SchemaSourceRepresentation source : sources) {
102 addLibSource(source);
107 default YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
108 YangSyntaxErrorException {
109 for (SchemaSourceRepresentation source : sources) {
110 addLibSource(source);
116 * Set supported features based on which all if-feature statements in the parsed YANG modules will be resolved. If
117 * this method is not invoked, all features will be supported.
119 * @param supportedFeatures Set of supported features in the final SchemaContext. If the set is empty, no features
120 * encountered will be supported.
122 YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
125 * Set YANG modules which can be deviated by specified modules during the parsing process. Map key (QNameModule)
126 * denotes a module which can be deviated by the modules in the Map value.
128 * @param modulesDeviatedByModules Map of YANG modules (Map key) which can be deviated by specified modules (Map
129 * value) in the final SchemaContext. If the map is empty, no deviations encountered
132 YangParser setModulesWithSupportedDeviations(
133 @NonNull SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules);
136 * Build the declared view of a combined view of declared statements.
138 * @return Ordered collection of declared statements from requested sources.
139 * @throws YangSyntaxErrorException When a syntactic error is encountered.
141 List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
144 * Build the effective view of a combined view of effective statements. Note that this representation, unlike
145 * {@link #buildDeclaredModel()} does not expose submodules as top-level contracts. These are available from their
146 * respective parent modules.
148 * @return Effective module statements indexed by their QNameModule.
149 * @throws YangSyntaxErrorException When a syntactic error is encountered.
151 // FIXME: 3.0.0: Make this method non-default
152 default Map<QNameModule, ModuleEffectiveStatement> buildEffectiveModel() throws YangParserException {
153 throw new UnsupportedOperationException(getClass() + " does not implement buildEffectiveModel()");
157 * Build effective {@link SchemaContext}.
159 * @return An effective schema context comprised of configured models.
160 * @throws YangSyntaxErrorException When a syntactic error is encountered.
162 SchemaContext buildSchemaContext() throws YangParserException;