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 org.eclipse.jdt.annotation.NonNull;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.common.QNameModule;
20 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
26 * Configurable single-use YANG parser. Each instance can be configured to use a different set of models after
27 * which it is built. Models once added cannot be removed. Implementations are expected to be NOT thread-safe.
29 * @author Robert Varga
32 public interface YangParser {
34 * Return enumeration of concrete types of {@link SchemaSourceRepresentation} parsers created from this factory
35 * support. Users can use this information prepare the source they have to a representation which will be accepted
38 * @return Enumeration of supported schema source representations.
40 Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
43 * Return the set of all YANG statements semantically supported by this parser instance.
45 * @return Set of all YANG statements semantically supported by this parser instance.
47 Set<QName> supportedStatements();
50 * Add main source. All main sources are present in resulting SchemaContext.
52 * @param source which should be added into main sources
53 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
54 * @throws IOException when an IO error occurs
55 * @throws IllegalArgumentException if the representation is not supported
57 YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
60 * Add main sources. All main sources are present in resulting SchemaContext.
62 * @param sources which should be added into main sources
63 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
64 * @throws IOException when an IO error occurs
65 * @throws IllegalArgumentException if the representation is not supported
67 default YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
68 YangSyntaxErrorException {
69 for (SchemaSourceRepresentation source : sources) {
75 default YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources) throws IOException,
76 YangSyntaxErrorException {
77 for (SchemaSourceRepresentation source : sources) {
83 YangParser addLibSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
86 * Add library sources. Only library sources required by main sources are present in resulting SchemaContext.
87 * Any other library sources are ignored and this also applies to error reporting.
90 * Note: Library sources are not supported in semantic version mode currently.
92 * @param sources YANG sources which should be added into library sources
93 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
94 * @throws IOException when an IO error occurs
95 * @throws IllegalArgumentException if the representation is not supported
97 default YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
98 YangSyntaxErrorException {
99 for (SchemaSourceRepresentation source : sources) {
100 addLibSource(source);
105 default YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
106 YangSyntaxErrorException {
107 for (SchemaSourceRepresentation source : sources) {
108 addLibSource(source);
114 * Set supported features based on which all if-feature statements in the parsed YANG modules will be resolved. If
115 * this method is not invoked, all features will be supported.
117 * @param supportedFeatures Set of supported features in the final SchemaContext. If the set is empty, no features
118 * encountered will be supported.
120 YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
123 * Set YANG modules which can be deviated by specified modules during the parsing process. Map key (QNameModule)
124 * denotes a module which can be deviated by the modules in the Map value.
126 * @param modulesDeviatedByModules Map of YANG modules (Map key) which can be deviated by specified modules (Map
127 * value) in the final SchemaContext. If the map is empty, no deviations encountered
130 YangParser setModulesWithSupportedDeviations(
131 @NonNull SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules);
134 * Build the declared view of a combined view of declared statements.
136 * @return Ordered collection of declared statements from requested sources.
137 * @throws YangSyntaxErrorException When a syntactic error is encountered.
139 List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
142 * Build the effective view of a combined view of effective statements. Note that this representation, unlike
143 * {@link #buildDeclaredModel()} does not expose submodules as top-level contracts. These are available from their
144 * respective parent modules.
146 * @return Effective module statements indexed by their QNameModule.
147 * @throws YangSyntaxErrorException When a syntactic error is encountered.
149 // FIXME: 3.0.0: Make this method non-default
150 default Map<QNameModule, ModuleEffectiveStatement> buildEffectiveModel() throws YangParserException {
151 throw new UnsupportedOperationException(getClass() + " does not implement buildEffectiveModel()");
155 * Build effective {@link SchemaContext}.
157 * @return An effective schema context comprised of configured models.
158 * @throws YangSyntaxErrorException When a syntactic error is encountered.
160 SchemaContext buildSchemaContext() throws YangParserException;