org.opendaylight.yangtools.yang.model.parser.api

Interface YangContextParser

All Superinterfaces:

YangModelParser

public interface YangContextParser
extends YangModelParser

Parse yang models and convert data to SchemaContext.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.yangtools.yang.model.api.SchemaContext	parseFile(File yangFile, File dependenciesDirectory) Parse yangFile file and all yang files found in directory.
org.opendaylight.yangtools.yang.model.api.SchemaContext	parseFiles(Collection<File> yangFiles) Parse one or more Yang model files and return the definitions of Yang modules defined in *.yang files; This method SHOULD be used if user need to parse multiple yang models that are referenced either through import or include statements.
org.opendaylight.yangtools.yang.model.api.SchemaContext	parseFiles(Collection<File> yangFiles, org.opendaylight.yangtools.yang.model.api.SchemaContext context) Parse one or more Yang model files and return the definitions of Yang modules defined in *.yang files.
org.opendaylight.yangtools.yang.model.api.SchemaContext	parseSources(Collection<com.google.common.io.ByteSource> sources) Parse one or more Yang model streams and return the definitions of Yang modules defined in *.yang files; This method SHOULD be used if user need to parse multiple yang models that are referenced either through import or include statements.
org.opendaylight.yangtools.yang.model.api.SchemaContext	parseSources(Collection<com.google.common.io.ByteSource> sources, org.opendaylight.yangtools.yang.model.api.SchemaContext context) Parse one or more Yang model streams and return the definitions of Yang modules defined in *.yang files.

Methods inherited from interface org.opendaylight.yangtools.yang.model.parser.api.YangModelParser

parseYangModels, parseYangModels, parseYangModels, parseYangModelsFromStreams, parseYangModelsFromStreams, parseYangModelsFromStreamsMapped, parseYangModelsMapped, resolveSchemaContext

Method Detail

parseFile

org.opendaylight.yangtools.yang.model.api.SchemaContext parseFile(File yangFile,
                                                                File dependenciesDirectory)
                                                                  throws IOException,
                                                                         YangSyntaxErrorException

Parse yangFile file and all yang files found in directory.

Parameters:

yangFile - file to parse

dependenciesDirectory - directory which contains additional yang files

Returns:

parsed data as SchemaContext. Resulting context will contains only module parsed from yangFile and modules which yangFile needs as dependencies.

Throws:

IOException

YangSyntaxErrorException

parseFiles

org.opendaylight.yangtools.yang.model.api.SchemaContext parseFiles(Collection<File> yangFiles)
                                                                   throws IOException

Parse one or more Yang model files and return the definitions of Yang modules defined in *.yang files;
This method SHOULD be used if user need to parse multiple yang models that are referenced either through import or include statements.

Parameters:

yangFiles - yang files to parse

Returns:

parsed data as SchemaContext

Throws:

IOException

parseFiles

org.opendaylight.yangtools.yang.model.api.SchemaContext parseFiles(Collection<File> yangFiles,
                                                                 org.opendaylight.yangtools.yang.model.api.SchemaContext context)
                                                                   throws IOException,
                                                                          YangSyntaxErrorException

Parse one or more Yang model files and return the definitions of Yang modules defined in *.yang files.
This method SHOULD be used if user has already parsed context and need to parse additinal yang models which can have dependencies on models in this context.

Parameters:

yangFiles - yang files to parse

context - SchemaContext containing already parsed yang models

Returns:

parsed data as SchemaContext

Throws:

IOException

YangSyntaxErrorException

parseSources

org.opendaylight.yangtools.yang.model.api.SchemaContext parseSources(Collection<com.google.common.io.ByteSource> sources)
                                                                     throws IOException,
                                                                            YangSyntaxErrorException

Parse one or more Yang model streams and return the definitions of Yang modules defined in *.yang files;
This method SHOULD be used if user need to parse multiple yang models that are referenced either through import or include statements.

Parameters:

sources - yang streams to parse

Returns:

parsed data as SchemaContext

Throws:

IOException

YangSyntaxErrorException

parseSources

org.opendaylight.yangtools.yang.model.api.SchemaContext parseSources(Collection<com.google.common.io.ByteSource> sources,
                                                                   org.opendaylight.yangtools.yang.model.api.SchemaContext context)
                                                                     throws IOException,
                                                                            YangSyntaxErrorException

Parse one or more Yang model streams and return the definitions of Yang modules defined in *.yang files.
This method SHOULD be used if user has already parsed context and need to parse additinal yang models which can have dependencies on models in this context.

Parameters:

sources - yang streams to parse

context - SchemaContext containing already parsed yang models

Returns:

parsed data as SchemaContext

Throws:

IOException

YangSyntaxErrorException