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

Class YangSourceFromCapabilitiesResolver

java.lang.Object

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

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

public final class YangSourceFromCapabilitiesResolver
extends YangSourceContextResolver

Source code resolver which resolves Yang Source Context against SchemaSourceProvider and set of QName which represent capabilities. This source code resolver is useful for components which deals with capability exchange similar to YANG/Netconf specification and there is SchemaSourceProvider able to retrieve YANG models.

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.yangtools.yang.parser.impl.util.YangSourceContextResolver

YangSourceContextResolver.ResolutionState

Constructor Summary

Constructors

Constructor and Description
YangSourceFromCapabilitiesResolver(Iterable<org.opendaylight.yangtools.yang.common.QName> capabilities, org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider<InputStream> schemaSourceProvider) Construct new YangSourceFromCapabilitiesResolver.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.base.Optional<YangModelDependencyInfo>	getDependencyInfo(org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier identifier) Returns dependency information for provided identifier Implementations are required to: return Optional.absent() If source code for source is not present return same dependency information for multiple invocations of this method for same source identifier. return latest available revision if SourceIdentifier does not specify revision.
YangSourceContext	resolveContext() Resolves YangSourceContext Implementators of this method should invoke YangSourceContextResolver.resolveSource(SourceIdentifier) for sources which should be present in YangSourceContext and YangSourceContextResolver.createSourceContext() to create resulting YangSourceContext which will contain state derived by callbacks to YangSourceContextResolver.getDependencyInfo(SourceIdentifier).

Methods inherited from class org.opendaylight.yangtools.yang.parser.impl.util.YangSourceContextResolver

createSourceContext, getSourceProvider, resolveSource, resolveSource

Methods inherited from class java.lang.Object

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

Constructor Detail

YangSourceFromCapabilitiesResolver

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

Construct new YangSourceFromCapabilitiesResolver.

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.

Method Detail

resolveContext

public YangSourceContext resolveContext()

Description copied from class: YangSourceContextResolver

Resolves YangSourceContext Implementators of this method should invoke YangSourceContextResolver.resolveSource(SourceIdentifier) for sources which should be present in YangSourceContext and YangSourceContextResolver.createSourceContext() to create resulting YangSourceContext which will contain state derived by callbacks to YangSourceContextResolver.getDependencyInfo(SourceIdentifier).

Specified by:

resolveContext in class YangSourceContextResolver

Returns:

Resolved YangSourceContext.

getDependencyInfo

public com.google.common.base.Optional<YangModelDependencyInfo> getDependencyInfo(org.opendaylight.yangtools.yang.model.util.repo.SourceIdentifier identifier)

Description copied from class: YangSourceContextResolver

Returns dependency information for provided identifier Implementations are required to:

• return Optional.absent() If source code for source is not present
• return same dependency information for multiple invocations of this method for same source identifier.
• return latest available revision if SourceIdentifier does not specify revision. If no revision is available Optional.absent() MUST be returned.

Internal state of this object (and resulting YangSourceContext will be updated as following:

• If Optional.absent() is returned:
  • source will be marked as YangSourceContextResolver.ResolutionState.MISSING_SOURCE and source identifier will be contained in - YangSourceContext.getMissingSources()
  • All sources which imported or included this source will be present in YangSourceContext.getMissingDependencies()

Parameters:

identifier - Source identifier

Returns:

Dependency Information for SourceIdentifier, Optional.absent() if no source is present.