import java.io.IOException;
import java.util.Collection;
import java.util.List;
-import java.util.Map;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
/**
*
* @return Enumeration of supported schema source representations.
*/
- Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
+ @NonNull Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
/**
* Return the set of all YANG statements semantically supported by this parser instance.
*
* @return Set of all YANG statements semantically supported by this parser instance.
*/
- Set<QName> supportedStatements();
+ @NonNull Set<QName> supportedStatements();
/**
* Add main source. All main sources are present in resulting SchemaContext.
* @throws IOException when an IO error occurs
* @throws IllegalArgumentException if the representation is not supported
*/
- YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
+ @NonNull YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
/**
* Add main sources. All main sources are present in resulting SchemaContext.
* @throws IOException when an IO error occurs
* @throws IllegalArgumentException if the representation is not supported
*/
- default YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
+ default @NonNull YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
YangSyntaxErrorException {
for (SchemaSourceRepresentation source : sources) {
addSource(source);
return this;
}
- default YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources) throws IOException,
- YangSyntaxErrorException {
+ default @NonNull YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources)
+ throws IOException, YangSyntaxErrorException {
for (SchemaSourceRepresentation source : sources) {
addSource(source);
}
* @throws IOException when an IO error occurs
* @throws IllegalArgumentException if the representation is not supported
*/
- default YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
+ default @NonNull YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
YangSyntaxErrorException {
for (SchemaSourceRepresentation source : sources) {
addLibSource(source);
return this;
}
- default YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
+ default @NonNull YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
YangSyntaxErrorException {
for (SchemaSourceRepresentation source : sources) {
addLibSource(source);
* @param supportedFeatures Set of supported features in the final SchemaContext. If the set is empty, no features
* encountered will be supported.
*/
- YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
+ @NonNull YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
/**
* Set YANG modules which can be deviated by specified modules during the parsing process. Map key (QNameModule)
* value) in the final SchemaContext. If the map is empty, no deviations encountered
* will be supported.
*/
- YangParser setModulesWithSupportedDeviations(
+ @NonNull YangParser setModulesWithSupportedDeviations(
@NonNull SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules);
/**
* @return Ordered collection of declared statements from requested sources.
* @throws YangSyntaxErrorException When a syntactic error is encountered.
*/
- List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
+ @NonNull List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
/**
* Build the effective view of a combined view of effective statements. Note that this representation, unlike
* @return Effective module statements indexed by their QNameModule.
* @throws YangSyntaxErrorException When a syntactic error is encountered.
*/
- Map<QNameModule, ModuleEffectiveStatement> buildEffectiveModel() throws YangParserException;
+ @NonNull EffectiveModelContext buildEffectiveModel() throws YangParserException;
/**
* Build effective {@link SchemaContext}.
*
* @return An effective schema context comprised of configured models.
* @throws YangSyntaxErrorException When a syntactic error is encountered.
+ * @deprecated Use {@link #buildEffectiveModel()} instead.
*/
- SchemaContext buildSchemaContext() throws YangParserException;
+ @Deprecated(forRemoval = true)
+ default @NonNull SchemaContext buildSchemaContext() throws YangParserException {
+ return buildEffectiveModel();
+ }
}