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;
16 import javax.annotation.Nonnull;
17 import javax.annotation.concurrent.NotThreadSafe;
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.repo.api.SchemaSourceRepresentation;
25 * Configurable single-use YANG parser. Each instance can be configured to use a different set of models after
26 * which it is built. Models once added cannot be removed.
28 * @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
37 * @return Enumeration of supported schema source representations.
39 Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
42 * Return the set of all YANG statements semantically supported by this parser instance.
44 * @return Set of all YANG statements semantically supported by this parser instance.
46 Set<QName> supportedStatements();
49 * Add main source. All main sources are present in resulting SchemaContext.
52 * 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(final SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
60 * Add main sources. All main sources are present in resulting SchemaContext.
63 * which should be added into main sources
64 * @throws YangSyntaxErrorException when one of the sources fails syntactic analysis
65 * @throws IOException when an IO error occurs
66 * @throws IllegalArgumentException if the representation is not supported
68 default YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
69 YangSyntaxErrorException {
70 for (SchemaSourceRepresentation source : sources) {
76 default YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources) throws IOException,
77 YangSyntaxErrorException {
78 for (SchemaSourceRepresentation source : sources) {
84 YangParser addLibSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
87 * Add library sources. Only library sources required by main sources are present in resulting SchemaContext.
88 * Any other library sources are ignored and this also applies to error reporting.
91 * Note: Library sources are not supported in semantic version mode currently.
94 * 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
117 * parsed YANG modules will be resolved. If this method is not invoked, all features will be supported.
119 * @param supportedFeatures
120 * Set of supported features in the final SchemaContext.
121 * If the set is empty, no features encountered will be supported.
123 YangParser setSupportedFeatures(@Nonnull final Set<QName> supportedFeatures);
126 * Set YANG modules which can be deviated by specified modules during the parsing process.
127 * Map key (QNameModule) denotes a module which can be deviated by the modules in the Map value.
129 * @param modulesDeviatedByModules
130 * Map of YANG modules (Map key) which can be deviated by specified modules (Map value) in the final
131 * SchemaContext. If the map is empty, no deviations encountered will be supported.
133 YangParser setModulesWithSupportedDeviations(
134 @Nonnull SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules);
137 * Build the declared view of a combined view of declared statements.
139 * @return Ordered collection of declared statements from requested sources.
141 List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
144 * Build effective {@link SchemaContext}
146 * @return An effective schema context comprised of configured models.
147 * @throws YangSyntaxErrorException When a syntactic error is encountered.
149 SchemaContext buildSchemaContext() throws YangParserException;