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

Class YangModelDependencyInfo

java.lang.Object

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

Direct Known Subclasses:

YangModelDependencyInfo.ModuleDependencyInfo, YangModelDependencyInfo.SubmoduleDependencyInfo

public abstract class YangModelDependencyInfo
extends Object

Helper transfer object which holds basic and dependency information for YANG model. There are two concrete implementations of this interface:

• YangModelDependencyInfo.ModuleDependencyInfo - Dependency information for module
• YangModelDependencyInfo.SubmoduleDependencyInfo - Dependency information for submodule

See Also:

YangModelDependencyInfo.ModuleDependencyInfo, YangModelDependencyInfo.SubmoduleDependencyInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YangModelDependencyInfo.ModuleDependencyInfo Dependency information for YANG module.
static class	YangModelDependencyInfo.SubmoduleDependencyInfo Dependency information for submodule, also provides name for parent module.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static YangModelDependencyInfo	fromAST(String name, org.antlr.v4.runtime.ParserRuleContext tree) Extracts YangModelDependencyInfo from an abstract syntax tree of a YANG model.
static YangModelDependencyInfo	fromInputStream(InputStream yangStream) Extracts YangModelDependencyInfo from input stream containing YANG model.
com.google.common.collect.ImmutableSet<ModuleImport>	getDependencies() Returns immutable collection of all module imports.
String	getFormattedRevision() Returns formatted revision string
static String	getLatestRevision(YangStatementParser.StatementContext module, String sourceName)
String	getName() Returns model name
com.google.common.base.Optional<SemVer>	getSemanticVersion() Returns semantic version of module
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getDependencies

public com.google.common.collect.ImmutableSet<ModuleImport> getDependencies()

Returns immutable collection of all module imports. This collection contains both import statements and include statements for submodules.

Returns:

Immutable collection of imports.

getName

public String getName()

Returns model name

Returns:

model name

getFormattedRevision

public String getFormattedRevision()

Returns formatted revision string

Returns:

formatted revision string

getSemanticVersion

public com.google.common.base.Optional<SemVer> getSemanticVersion()

Returns semantic version of module

Returns:

semantic version

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

fromAST

public static YangModelDependencyInfo fromAST(String name,
                                              org.antlr.v4.runtime.ParserRuleContext tree)
                                       throws YangSyntaxErrorException

Extracts YangModelDependencyInfo from an abstract syntax tree of a YANG model.

Parameters:

tree - Abstract syntax tree

Returns:

YangModelDependencyInfo

Throws:

YangSyntaxErrorException - If the AST is not a valid YANG module/submodule

fromInputStream

public static YangModelDependencyInfo fromInputStream(InputStream yangStream)

Extracts YangModelDependencyInfo from input stream containing YANG model. This parsing does not validate full YANG module, only parses header up to the revisions and imports.

Parameters:

yangStream - Opened Input stream containing text source of YANG model

Returns:

YangModelDependencyInfo

Throws:

IllegalArgumentException - If input stream is not valid YANG stream

getLatestRevision

public static String getLatestRevision(YangStatementParser.StatementContext module,
                                       String sourceName)