org.opendaylight.yangtools.yang.parser.impl.util

Class YangSourceContext

java.lang.Object

org.opendaylight.yangtools.yang.parser.impl.util.YangSourceContext

All Implemented Interfaces:

Closeable, AutoCloseable, org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>>, org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>, org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider<InputStream>

@ThreadSafe
public class YangSourceContext
extends Object
implements org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>, Closeable, org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>>

Context of YANG model sources YANG sources context represent information learned about set of model sources which could be derived from dependency information only. Contains following information:

• getValidSources() - set of SourceIdentifier which have their dependencies present and are safe to be used by full blown parser.
• getMissingSources() - set of SourceIdentifier which have been referenced by other YANG sources, but source code for them is missing.
• getMissingDependencies() - map of SourceIdentifier and their imports for which source codes was not available. YangSourceContext may be associated with SchemaSourceProvider (see getDelegate(), which was used for retrieval of sources during context computation. YangSourceContext may be used as schema source provider to retrieve this sources.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static YangSourceContext	createFrom(Iterable<org.opendaylight.yangtools.yang.common.QName> capabilities, org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider<InputStream> schemaSourceProvider) Creates YANG Source context from supplied capabilities and schema source provider.
static YangSourceContext	createFrom(Map<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier,YangModelDependencyInfo> moduleDependencies, org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream> sourceProvider)
org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>	getDelegate()
com.google.common.collect.ImmutableMultimap<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier,org.opendaylight.yangtools.yang.model.api.ModuleImport>	getMissingDependencies() Returns a multimap of Source Identifier and imports which had missing sources.
com.google.common.collect.ImmutableSet<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier>	getMissingSources() Returns set of source identifiers, whom sources was not resolved.
com.google.common.base.Optional<InputStream>	getSchemaSource(org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier sourceIdentifier)
com.google.common.base.Optional<InputStream>	getSchemaSource(String moduleName, com.google.common.base.Optional<String> revision)
Collection<com.google.common.io.ByteSource>	getValidByteSources()
List<InputStream>	getValidInputStreams() Deprecated. Use getValidByteSources()
static List<InputStream>	getValidInputStreams(YangSourceContext context) Deprecated.
com.google.common.collect.ImmutableSet<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier>	getValidSources() Returns set of valid source identifiers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getValidSources

public com.google.common.collect.ImmutableSet<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier> getValidSources()

Returns set of valid source identifiers. Source identifier is considered valid if it's source was present during resolution and sources for all known dependencies was present at the time of creation of YangSourceContext.

Returns:

Set of valid source identifiers.

getMissingSources

public com.google.common.collect.ImmutableSet<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier> getMissingSources()

Returns set of source identifiers, whom sources was not resolved. Source is considered missing if the source was not present during resolution of YangSourceContext.

Returns:

Set of missing sources.

getMissingDependencies

public com.google.common.collect.ImmutableMultimap<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier,org.opendaylight.yangtools.yang.model.api.ModuleImport> getMissingDependencies()

Returns a multimap of Source Identifier and imports which had missing sources. Maps a source identifier to its imports, which was not resolved during resolution of this context, so it is unable to fully processed source identifier.

Returns:

Multi-map of source identifier to it's unresolved dependencies.

getSchemaSource

public com.google.common.base.Optional<InputStream> getSchemaSource(String moduleName,
                                                           com.google.common.base.Optional<String> revision)

Specified by:

getSchemaSource in interface org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider<InputStream>

getSchemaSource

public com.google.common.base.Optional<InputStream> getSchemaSource(org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier sourceIdentifier)

Specified by:

getSchemaSource in interface org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>

getDelegate

public org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream> getDelegate()

Specified by:

getDelegate in interface org.opendaylight.yangtools.concepts.Delegator<org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream>>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createFrom

public static YangSourceContext createFrom(Iterable<org.opendaylight.yangtools.yang.common.QName> capabilities,
                           org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider<InputStream> schemaSourceProvider)

Creates YANG Source context from supplied capabilities and schema source provider.

Parameters:

capabilities - Set of QName representing module capabilities, QName.getLocalName() represents source name and QName.getRevision() represents revision of source.

schemaSourceProvider - - SchemaSourceProvider which should be used to resolve sources.

Returns:

YANG source context which describes resolution of capabilities and their dependencies against supplied schema source provider.

createFrom

public static YangSourceContext createFrom(Map<org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier,YangModelDependencyInfo> moduleDependencies,
                           org.opendaylight.yangtools.yang.model.util.repo.AdvancedSchemaSourceProvider<InputStream> sourceProvider)

getValidInputStreams

@Deprecated
public List<InputStream> getValidInputStreams()

Deprecated. Use getValidByteSources()

Returns a list of valid input streams from YANG Source Context using supplied schema source provider.

Returns:

List of input streams.

getValidByteSources

public Collection<com.google.common.io.ByteSource> getValidByteSources()
                                                                throws IOException

Throws:

IOException

getValidInputStreams

@Deprecated
public static List<InputStream> getValidInputStreams(YangSourceContext context)

Deprecated.