Package org.opendaylight.yangtools.yang.model.spi.source

Interface SourceInfo

All Known Implementing Classes:

SourceInfo.Module, SourceInfo.Submodule

@NonNullByDefault
public sealed interface SourceInfo
permits SourceInfo.Module, SourceInfo.Submodule

Linkage information about a particular SourceRepresentation. It has two specializations

1. SourceInfo.Module pertaining to SourceRepresentation which have module as its root statement
2. SourceInfo.Submodule pertaining to SourceRepresentation which have submodule as its root statement

This interface captures the basic metadata needed for interpretation and linkage of the source, as represented by the following ABNF constructs placed at the start of a YANG file:

• module-header-stmts or submodule-header-stmts
• linkage-stmts
• revision-stmts

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SourceInfo.Builder<B extends SourceInfo.Builder<B,I>,I extends SourceInfo>
static final record	SourceInfo.Module	A SourceInfo about a ModuleStatement-backed source.
static final record	SourceInfo.Submodule	A SourceInfo about a submodule.

Method Summary

Modifier and Type	Method	Description
ImmutableSet<SourceDependency.Import>	imports()	Return all SourceDependency.Import dependencies.
ImmutableSet<SourceDependency.Include>	includes()	Return all SourceDependency.Include dependencies.
ImmutableSet<Revision>	revisions()	The set of all RevisionDateStatement mentioned in RevisionStatements.
SourceIdentifier	sourceId()	Return the SourceIdentifier of this source, as expressed by RootDeclaredStatement.argument() contract coupled with the first entry in revisions().
YangVersion	yangVersion()	Return YangVersion of the source.

Method Details

sourceId

SourceIdentifier sourceId()

Return the SourceIdentifier of this source, as expressed by RootDeclaredStatement.argument() contract coupled with the first entry in revisions().

Returns:

name of this source.

yangVersion

YangVersion yangVersion()

Return YangVersion of the source. If no YangVersionStatement is present, this method will return YangVersion.VERSION_1.

Returns:

YangVersion of the source

revisions

ImmutableSet<Revision> revisions()

The set of all RevisionDateStatement mentioned in RevisionStatements. The returned set is ordered in reverse order, i.e. newest revision is encountered first.

Returns:

all revisions known by this source

imports

ImmutableSet<SourceDependency.Import> imports()

Return all SourceDependency.Import dependencies.

Returns:

all import dependencies

includes

ImmutableSet<SourceDependency.Include> includes()

Return all SourceDependency.Include dependencies.

Returns:

all include dependencies