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

Interface YangModelParser

All Known Subinterfaces:

YangContextParser

Deprecated.

Use YangContextParser instead

@Deprecated
public interface YangModelParser

Yang Model Parser interface is designed for parsing yang models and convert the information to Data Schema Tree.

Method Summary

Methods

Modifier and Type	Method and Description
Set<org.opendaylight.yangtools.yang.model.api.Module>	parseYangModels(File yangFile, File directory) Deprecated. Use YangContextParser.parseFile(File, File) instead
Set<org.opendaylight.yangtools.yang.model.api.Module>	parseYangModels(List<File> yangFiles) Deprecated. Use YangContextParser.parseFiles(Collection) instead
Set<org.opendaylight.yangtools.yang.model.api.Module>	parseYangModels(List<File> yangFiles, org.opendaylight.yangtools.yang.model.api.SchemaContext context) Deprecated. Use YangContextParser.parseFiles(Collection, SchemaContext) instead
Set<org.opendaylight.yangtools.yang.model.api.Module>	parseYangModelsFromStreams(List<InputStream> yangModelStreams) Deprecated. Use YangContextParser.parseSources(Collection) instead
Set<org.opendaylight.yangtools.yang.model.api.Module>	parseYangModelsFromStreams(List<InputStream> yangModelStreams, org.opendaylight.yangtools.yang.model.api.SchemaContext context) Deprecated. Use YangContextParser.parseSources(Collection, SchemaContext) instead
Map<InputStream,org.opendaylight.yangtools.yang.model.api.Module>	parseYangModelsFromStreamsMapped(Collection<InputStream> yangModelStreams) Deprecated. Use YangContextParser#parseSources(java.util.Collection)
Map<File,org.opendaylight.yangtools.yang.model.api.Module>	parseYangModelsMapped(Collection<File> yangFiles) Deprecated. Equivalent to parseYangModels(List) that returns parsed modules mapped to Files from which they were parsed.
org.opendaylight.yangtools.yang.model.api.SchemaContext	resolveSchemaContext(Set<org.opendaylight.yangtools.yang.model.api.Module> modules) Deprecated. use YangContextParser methods that return SchemaContext in one step

Method Detail

parseYangModels

@Deprecated
Set<org.opendaylight.yangtools.yang.model.api.Module> parseYangModels(File yangFile,
                                                                               File directory)

Deprecated. Use YangContextParser.parseFile(File, File) instead

Parse yangFile file and all yang files found in directory.

Parameters:

yangFile - file to parse

directory - directory which contains additional yang files

Returns:

Set of Yang Modules

parseYangModels

@Deprecated
Set<org.opendaylight.yangtools.yang.model.api.Module> parseYangModels(List<File> yangFiles)

Deprecated. Use YangContextParser.parseFiles(Collection) instead

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:

Set of Yang Modules

parseYangModels

@Deprecated
Set<org.opendaylight.yangtools.yang.model.api.Module> parseYangModels(List<File> yangFiles,
                                                                               org.opendaylight.yangtools.yang.model.api.SchemaContext context)

Deprecated. Use YangContextParser.parseFiles(Collection, SchemaContext) instead

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:

Set of Yang Modules

parseYangModelsMapped

Map<File,org.opendaylight.yangtools.yang.model.api.Module> parseYangModelsMapped(Collection<File> yangFiles)

Deprecated.

Equivalent to parseYangModels(List) that returns parsed modules mapped to Files from which they were parsed.

Parameters:

yangFiles - yang files to parse

Returns:

Map of Yang Modules

parseYangModelsFromStreams

@Deprecated
Set<org.opendaylight.yangtools.yang.model.api.Module> parseYangModelsFromStreams(List<InputStream> yangModelStreams)

Deprecated. Use YangContextParser.parseSources(Collection) instead

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:

yangModelStreams - yang streams to parse

Returns:

Set of Yang Modules

parseYangModelsFromStreams

@Deprecated
Set<org.opendaylight.yangtools.yang.model.api.Module> parseYangModelsFromStreams(List<InputStream> yangModelStreams,
                                                                                          org.opendaylight.yangtools.yang.model.api.SchemaContext context)

Deprecated. Use YangContextParser.parseSources(Collection, SchemaContext) instead

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 additional yang models which can have dependencies on models in this context.

Parameters:

yangModelStreams - yang streams to parse

context - SchemaContext containing already parsed yang models

Returns:

Set of Yang Modules

parseYangModelsFromStreamsMapped

@Deprecated
Map<InputStream,org.opendaylight.yangtools.yang.model.api.Module> parseYangModelsFromStreamsMapped(Collection<InputStream> yangModelStreams)

Deprecated. Use YangContextParser#parseSources(java.util.Collection)

Equivalent to parseYangModels(List) that returns parsed modules mapped to InputStreams from which they were parsed.

Parameters:

yangModelStreams - yang streams to parse

Returns:

Map of Yang Modules

resolveSchemaContext

@Deprecated
org.opendaylight.yangtools.yang.model.api.SchemaContext resolveSchemaContext(Set<org.opendaylight.yangtools.yang.model.api.Module> modules)

Deprecated. use YangContextParser methods that return SchemaContext in one step

Creates SchemaContext from specified Modules. The modules SHOULD not contain any unresolved Schema Nodes or Type Definitions. By unresolved Schema Nodes or Type Definitions we mean that the Module should not contain ANY Schema Nodes that contains UnknownTypeDefinition and all dependencies although via import or include definitions are resolved.

Parameters:

modules - Set of Yang Modules

Returns:

Schema Context instance constructed from whole Set of Modules.