org.opendaylight.yangtools.yang.parser.rfc7950.stmt

Class AbstractEffectiveModule<D extends DeclaredStatement<String>>

java.lang.Object

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.DeclaredEffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNode<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractSchemaEffectiveDocumentedNode<String,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveModule<D>

All Implemented Interfaces:

DataNodeContainer, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<String,D>, ModelStatement<String>, Module, NamespaceRevisionAware, NotificationNodeContainer, MutableStatement

@Beta
public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>>
extends AbstractSchemaEffectiveDocumentedNode<String,D>
implements Module, MutableStatement

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEffectiveModule(StmtContext<String,D,? extends EffectiveStatement<String,?>> ctx)

Method Summary

Modifier and Type	Method and Description
Optional<DataSchemaNode>	findDataChildByName(QName name) Returns the child node corresponding to the specified name.
Set<AugmentationSchemaNode>	getAugmentations() Returns AugmentationSchema instances which contain data from augment statements defined in the module.
Set<DataSchemaNode>	getChildNodes() Returns set of all child nodes defined within this DataNodeContainer.
Optional<String>	getContact() Returns the module contact.
Set<Deviation>	getDeviations() Returns Deviation instances which contain data from deviation statements defined in the module.
List<ExtensionDefinition>	getExtensionSchemaNodes() Returns ExtensionDefinition instances which contain data from extension statements defined in the module.
Set<FeatureDefinition>	getFeatures() Returns FeatureDefinition instances which contain data from feature statements defined in the module.
Set<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
Set<IdentitySchemaNode>	getIdentities() Returns IdentitySchemaNode instances which contain data from identity statements defined in the module.
Set<ModuleImport>	getImports() Returns imports which represents YANG modules which are imported to this module via import statement.
String	getName() Returns the name of the module which is specified as argument of YANG module keyword.
URI	getNamespace() Returns the namespace of the module which is specified as argument of YANG namespace keyword.
Set<NotificationDefinition>	getNotifications() Return the set of notifications in this container, keyed by QName.
Optional<String>	getOrganization() Returns the module organization.
String	getPrefix() Returns the prefix of the module.
Optional<Revision>	getRevision() Returns the revision date for the module.
Set<RpcDefinition>	getRpcs() Returns RpcDefinition instances which contain data from rpc statements defined in the module.
Optional<SemVer>	getSemanticVersion() Returns the semantic version of yang module.
Set<Module>	getSubmodules()
Set<TypeDefinition<?>>	getTypeDefinitions() Returns set of all newly defined types within this DataNodeContainer.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema nodes which belongs to this instance.
Set<UsesNode>	getUses() Returns grouping nodes used ny this container.
YangVersion	getYangVersion() Returns the YANG version.
void	seal() Finish statement and make it immutable.
String	toString()

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractSchemaEffectiveDocumentedNode

getNamespaceContents

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNode

getDescription, getReference, getStatus

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.DeclaredEffectiveStatementBase

argument, getDeclared, getStatementSource, statementDefinition

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementBase

allSubstatementsOfType, effectiveSubstatements, firstEffective, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, get, getAll, initSubstatements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.Module

getQNameModule

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer

findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement

findAll, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, streamEffectiveSubstatements

Constructor Detail

AbstractEffectiveModule

protected AbstractEffectiveModule(StmtContext<String,D,? extends EffectiveStatement<String,?>> ctx)

Method Detail

getNamespace

public URI getNamespace()

Description copied from interface: Module

Returns the namespace of the module which is specified as argument of YANG namespace keyword. If you need both namespace and revision, please consider using Module.getQNameModule().

Specified by:

getNamespace in interface Module

Specified by:

getNamespace in interface NamespaceRevisionAware

Returns:

URI format of the namespace of the module

getName

public String getName()

Description copied from interface: Module

Returns the name of the module which is specified as argument of YANG module keyword.

Specified by:

getName in interface Module

Returns:

string with the name of the module

getRevision

public Optional<Revision> getRevision()

Description copied from interface: Module

Returns the revision date for the module. If you need both namespace and revision, please consider using Module.getQNameModule().

Specified by:

getRevision in interface Module

Specified by:

getRevision in interface NamespaceRevisionAware

Returns:

date of the module revision which is specified as argument of YANG revison keyword

getPrefix

public String getPrefix()

Description copied from interface: Module

Returns the prefix of the module.

Specified by:

getPrefix in interface Module

Returns:

string with the module prefix which is specified as argument of YANG prefix keyword

getYangVersion

public YangVersion getYangVersion()

Description copied from interface: Module

Returns the YANG version.

Specified by:

getYangVersion in interface Module

Returns:

YANG version of this module.

getOrganization

public Optional<String> getOrganization()

Description copied from interface: Module

Returns the module organization.

Specified by:

getOrganization in interface Module

Returns:

string with the name of the organization specified in the module as the argument of YANG organization keyword

getContact

public Optional<String> getContact()

Description copied from interface: Module

Returns the module contact.

The contact represents the person or persons to whom technical queries concerning this module should be sent, such as their name, postal address, telephone number, and electronic mail address.

Specified by:

getContact in interface Module

Returns:

string with the contact data specified in the module as the argument of YANG contact keyword

getImports

public Set<ModuleImport> getImports()

Description copied from interface: Module

Returns imports which represents YANG modules which are imported to this module via import statement.

Specified by:

getImports in interface Module

Returns:

set of module imports which are specified in the module as the argument of YANG import keywords.

getSubmodules

public Set<Module> getSubmodules()

Specified by:

getSubmodules in interface Module

getFeatures

public Set<FeatureDefinition> getFeatures()

Description copied from interface: Module

Returns FeatureDefinition instances which contain data from feature statements defined in the module.

The feature is used to define a mechanism by which portions of the schema are marked as conditional.

Specified by:

getFeatures in interface Module

Returns:

feature statements in lexicographical order which are specified in the module as the argument of YANG feature keywords.

getNotifications

public Set<NotificationDefinition> getNotifications()

Description copied from interface: NotificationNodeContainer

Return the set of notifications in this container, keyed by QName. RFC7950 specifies that AugmentationSchemaNodes, GroupingDefinitions, ListSchemaNodes and ContainerSchemaNodes can also contain NotificationDefinitions.

Specified by:

getNotifications in interface NotificationNodeContainer

Returns:

set of notification nodes

getAugmentations

public Set<AugmentationSchemaNode> getAugmentations()

Description copied from interface: Module

Returns AugmentationSchema instances which contain data from augment statements defined in the module.

Specified by:

getAugmentations in interface Module

Returns:

set of the augmentation schema instances which are specified in the module as YANG augment keyword and are lexicographically ordered

getRpcs

public Set<RpcDefinition> getRpcs()

Description copied from interface: Module

Returns RpcDefinition instances which contain data from rpc statements defined in the module.

Specified by:

getRpcs in interface Module

Returns:

set of the rpc definition instances which are specified in the module as YANG rpc keywords and are lexicographicaly ordered

getDeviations

public Set<Deviation> getDeviations()

Description copied from interface: Module

Returns Deviation instances which contain data from deviation statements defined in the module.

Specified by:

getDeviations in interface Module

Returns:

set of the deviation instances

getExtensionSchemaNodes

public List<ExtensionDefinition> getExtensionSchemaNodes()

Description copied from interface: Module

Returns ExtensionDefinition instances which contain data from extension statements defined in the module.

Specified by:

getExtensionSchemaNodes in interface Module

Returns:

set of extension definition instances which are specified in the module as YANG extension keyword and are lexicographically ordered

getIdentities

public Set<IdentitySchemaNode> getIdentities()

Description copied from interface: Module

Returns IdentitySchemaNode instances which contain data from identity statements defined in the module.

Specified by:

getIdentities in interface Module

Returns:

set of identity schema node instances which are specified in the module as YANG identity keywords and are lexicographically ordered

getUnknownSchemaNodes

public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: DocumentedNode

Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty list.

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Returns:

list of unknown schema nodes defined under this node.

getTypeDefinitions

public final Set<TypeDefinition<?>> getTypeDefinitions()

Description copied from interface: DataNodeContainer

Returns set of all newly defined types within this DataNodeContainer.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Returns:

typedef statements in lexicographical order

getChildNodes

public final Set<DataSchemaNode> getChildNodes()

Description copied from interface: DataNodeContainer

Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.

Note that the nodes returned are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are present instead of their children. This is consistent with schema tree.

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

getGroupings

public final Set<GroupingDefinition> getGroupings()

Description copied from interface: DataNodeContainer

Returns set of all groupings defined within this DataNodeContainer.

Specified by:

getGroupings in interface DataNodeContainer

Returns:

grouping statements in lexicographical order

findDataChildByName

public final Optional<DataSchemaNode> findDataChildByName(QName name)

Description copied from interface: DataNodeContainer

Returns the child node corresponding to the specified name.

Note that the nodes searched are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are returned instead of their matching children.

Specified by:

findDataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

child node of this DataNodeContainer if child with given name is present, empty otherwise

getUses

public Set<UsesNode> getUses()

Description copied from interface: DataNodeContainer

Returns grouping nodes used ny this container.

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer

getSemanticVersion

public Optional<SemVer> getSemanticVersion()

Description copied from interface: Module

Returns the semantic version of yang module.

If the semantic version is not specified, default semantic version of module is returned.

Specified by:

getSemanticVersion in interface Module

Returns:

SemVer semantic version of yang module which is specified as argument of (urn:opendaylight:yang:extension:semantic-version?revision =2016-02-02)semantic-version statement

toString

public String toString()

Overrides:

toString in class Object

seal

public void seal()

Description copied from interface: MutableStatement

Finish statement and make it immutable. After this method is invoked, any further modifications of current object are not allowed.

Specified by:

seal in interface MutableStatement