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

Class AbstractEffectiveModule<D extends DeclaredStatement<UnqualifiedQName>,E extends DataTreeAwareEffectiveStatement<UnqualifiedQName,D>>

java.lang.Object

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement<A,D>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithSchemaTree<A,D,E>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithDataTree<A,D,E>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D,E>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements<UnqualifiedQName,D,E>

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

All Implemented Interfaces:

Immutable, MutationBehaviour<Immutable>, DataNodeContainer, DocumentedNode, EffectiveStatement<UnqualifiedQName,D>, ModelStatement<UnqualifiedQName>, ModuleLike, NotificationNodeContainer, QNameModuleAware, NotificationNodeContainerCompat<UnqualifiedQName,D,E>, SchemaTreeAwareEffectiveStatement<UnqualifiedQName,D>, EffectiveStatementMixins.DocumentedNodeMixin<UnqualifiedQName,D>

@Beta
public abstract class AbstractEffectiveModule<D extends DeclaredStatement<UnqualifiedQName>,E extends DataTreeAwareEffectiveStatement<UnqualifiedQName,D>>
extends AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements<UnqualifiedQName,D,E>
implements ModuleLike, EffectiveStatementMixins.DocumentedNodeMixin<UnqualifiedQName,D>, NotificationNodeContainerCompat<UnqualifiedQName,D,E>

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree

AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements<A,D extends DeclaredStatement<A>,E extends DataTreeAwareEffectiveStatement<A,D>>

Nested classes/interfaces inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement

AbstractDeclaredEffectiveStatement.Default<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultArgument<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultWithArgument<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D extends DeclaredStatement<A>,E extends DataTreeAwareEffectiveStatement<A,D>>, AbstractDeclaredEffectiveStatement.DefaultWithSchemaTree<A,D extends DeclaredStatement<A>,E extends SchemaTreeAwareEffectiveStatement<A,D>>, AbstractDeclaredEffectiveStatement.WithDataTree<A,D extends DeclaredStatement<A>,E extends DataTreeAwareEffectiveStatement<A,D>>, AbstractDeclaredEffectiveStatement.WithSchemaTree<A,D extends DeclaredStatement<A>,E extends SchemaTreeAwareEffectiveStatement<A,D>>

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

DocumentedNode.WithStatus

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DocumentedNodeMixin

EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D extends DeclaredStatement<A>>

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

SchemaTreeAwareEffectiveStatement.Namespace<T extends SchemaTreeEffectiveStatement<?>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEffectiveModule(EffectiveStmtCtx.Current<UnqualifiedQName,D> stmt, ImmutableList<? extends EffectiveStatement<?,?>> substatements, String prefix)

Method Summary

Modifier and Type	Method	Description
protected void	appendPrefixes(EffectiveStmtCtx.Current<?,?> stmt, ImmutableMap.Builder<String,ModuleEffectiveStatement> builder)
UnqualifiedQName	argument()	Returns statement argument.
protected static @NonNull ImmutableMap<QName,DataTreeEffectiveStatement<?>>	createDataTreeNamespace(Collection<SchemaTreeEffectiveStatement<?>> schemaTreeStatements, ImmutableMap<QName,SchemaTreeEffectiveStatement<?>> schemaTreeNamespace)
protected static @NonNull Map<QName,SchemaTreeEffectiveStatement<?>>	createSchemaTreeNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)
DataSchemaNode	dataChildByName(QName name)	Returns the child node corresponding to the specified name.
protected static @NonNull String	findPrefix(CommonStmtCtx stmt, Collection<? extends EffectiveStatement<?,?>> substatements, String type, String name)
<K,V,N extends IdentifierNamespace<K,V>> Optional<? extends V>	get(Class<N> namespace, K identifier)	Returns value associated with supplied identifier.
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAll(Class<N> namespace)	Returns all local values from supplied namespace.
Collection<? extends @NonNull AugmentationSchemaNode>	getAugmentations()	Returns AugmentationSchemaNode instances which contain data from augment statements defined in the module.
Collection<? extends DataSchemaNode>	getChildNodes()	Returns set of all child nodes defined within this DataNodeContainer.
Optional<String>	getContact()	Returns the module contact.
Collection<? extends @NonNull Deviation>	getDeviations()	Returns Deviation instances which contain data from deviation statements defined in the module.
Collection<? extends @NonNull ExtensionDefinition>	getExtensionSchemaNodes()	Returns ExtensionDefinition instances which contain data from extension statements defined in the module.
Collection<? extends @NonNull FeatureDefinition>	getFeatures()	Returns FeatureDefinition instances which contain data from feature statements defined in the module.
Collection<? extends GroupingDefinition>	getGroupings()	Returns set of all groupings defined within this DataNodeContainer.
Collection<? extends @NonNull IdentitySchemaNode>	getIdentities()	Returns IdentitySchemaNode instances which contain data from identity statements defined in the module.
Collection<? extends @NonNull 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 statement.
Collection<? extends @NonNull 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.
Collection<? extends @NonNull 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.
Collection<? extends TypeDefinition<?>>	getTypeDefinitions()	Returns set of all newly defined types within this DataNodeContainer.
Collection<? extends UsesNode>	getUses()	Returns grouping nodes used ny this container.
YangVersion	getYangVersion()	Returns the YANG version.
protected static @NonNull Object	maskList(ImmutableList<?> list)	Utility method for squashing singleton lists into single objects.
protected static @NonNull Object	maskSet(ImmutableSet<?> set)
String	toString()
protected static @NonNull ImmutableList<? extends @NonNull EffectiveStatement<?,?>>	unmaskList(@NonNull Object masked)	Utility method for recovering singleton lists squashed by maskList(ImmutableList).
protected static <T> @NonNull ImmutableList<T>	unmaskList(@NonNull Object masked, @NonNull Class<T> type)	Utility method for recovering singleton lists squashed by maskList(ImmutableList).
protected static <T> @NonNull ImmutableSet<T>	unmaskSet(@NonNull Object masked, @NonNull Class<T> type)

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements

effectiveSubstatements

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree

dataTreeNamespace, getDeclared, schemaTreeNamespace

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithDataTree

getNamespaceContents

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithSchemaTree

dataSchemaNode

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement

statementOrigin

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.DataNodeContainer

findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

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

effectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, get, getAll, getDeclared, streamEffectiveSubstatements

Methods inherited from interface org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DocumentedNodeMixin

getDescription, getReference, getUnknownSchemaNodes

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

statementDefinition, statementOrigin

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

getSubmodules

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat

findNotification

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

getNamespace, getQNameModule, getRevision

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement

findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode

Constructor Detail

AbstractEffectiveModule

protected AbstractEffectiveModule(EffectiveStmtCtx.Current<UnqualifiedQName,D> stmt,
                                  ImmutableList<? extends EffectiveStatement<?,?>> substatements,
                                  String prefix)

Method Detail

argument

public UnqualifiedQName argument()

Description copied from interface: ModelStatement

Returns statement argument.

Specified by:

argument in interface ModelStatement<D extends DeclaredStatement<UnqualifiedQName>>

Returns:

statement argument.

getName

public String getName()

Description copied from interface: ModuleLike

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

Specified by:

getName in interface ModuleLike

Returns:

string with the name of the module

getPrefix

public String getPrefix()

Description copied from interface: ModuleLike

Returns the prefix of the module.

Specified by:

getPrefix in interface ModuleLike

Returns:

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

getYangVersion

public YangVersion getYangVersion()

Description copied from interface: ModuleLike

Returns the YANG version.

Specified by:

getYangVersion in interface ModuleLike

Returns:

YANG version of this module.

getOrganization

public Optional<String> getOrganization()

Description copied from interface: ModuleLike

Returns the module organization.

Specified by:

getOrganization in interface ModuleLike

Returns:

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

getContact

public Optional<String> getContact()

Description copied from interface: ModuleLike

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 ModuleLike

Returns:

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

getImports

public Collection<? extends @NonNull ModuleImport> getImports()

Description copied from interface: ModuleLike

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

Specified by:

getImports in interface ModuleLike

Returns:

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

getFeatures

public Collection<? extends @NonNull FeatureDefinition> getFeatures()

Description copied from interface: ModuleLike

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 ModuleLike

Returns:

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

getNotifications

public Collection<? extends @NonNull 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 Collection<? extends @NonNull AugmentationSchemaNode> getAugmentations()

Description copied from interface: ModuleLike

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

Specified by:

getAugmentations in interface ModuleLike

Returns:

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

getRpcs

public Collection<? extends @NonNull RpcDefinition> getRpcs()

Description copied from interface: ModuleLike

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

Specified by:

getRpcs in interface ModuleLike

Returns:

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

getDeviations

public Collection<? extends @NonNull Deviation> getDeviations()

Description copied from interface: ModuleLike

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

Specified by:

getDeviations in interface ModuleLike

Returns:

set of the deviation instances

getExtensionSchemaNodes

public Collection<? extends @NonNull ExtensionDefinition> getExtensionSchemaNodes()

Description copied from interface: ModuleLike

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

Specified by:

getExtensionSchemaNodes in interface ModuleLike

Returns:

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

getIdentities

public Collection<? extends @NonNull IdentitySchemaNode> getIdentities()

Description copied from interface: ModuleLike

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

Specified by:

getIdentities in interface ModuleLike

Returns:

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

getTypeDefinitions

public final Collection<? extends 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 Collection<? extends 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 Collection<? extends 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

dataChildByName

public final DataSchemaNode dataChildByName(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. This is consistent with schema tree.

Specified by:

dataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

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

getUses

public Collection<? extends 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: ModuleLike

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 ModuleLike

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

findPrefix

protected static final @NonNull String findPrefix(CommonStmtCtx stmt,
                                                  Collection<? extends EffectiveStatement<?,?>> substatements,
                                                  String type,
                                                  String name)

appendPrefixes

protected final void appendPrefixes(EffectiveStmtCtx.Current<?,?> stmt,
                                    ImmutableMap.Builder<String,ModuleEffectiveStatement> builder)

get

public final <K,V,N extends IdentifierNamespace<K,V>> Optional<? extends V> get(Class<N> namespace,
                                                                                                  K identifier)

Description copied from interface: EffectiveStatement

Returns value associated with supplied identifier.

Specified by:

get in interface EffectiveStatement<A,D extends DeclaredStatement<A>>

Type Parameters:

K - Identifier type

V - Value type

N - Namespace identifier type

Parameters:

namespace - Namespace type

identifier - Identifier of element.

Returns:

Value if present

getAll

public final <K,V,N extends IdentifierNamespace<K,V>> Map<K,V> getAll(Class<N> namespace)

Description copied from interface: EffectiveStatement

Returns all local values from supplied namespace.

Specified by:

getAll in interface EffectiveStatement<A,D extends DeclaredStatement<A>>

Type Parameters:

K - Identifier type

V - Value type

N - Namespace identifier type

Parameters:

namespace - Namespace type

Returns:

Key-value mappings, empty if the namespace does not exist.

unmaskList

protected static final @NonNull ImmutableList<? extends @NonNull EffectiveStatement<?,?>> unmaskList(@NonNull Object masked)

Utility method for recovering singleton lists squashed by maskList(ImmutableList).

Parameters:

masked - list to unmask

Returns:

Unmasked list

Throws:

NullPointerException - if masked is null

ClassCastException - if masked object does not match EffectiveStatement

createSchemaTreeNamespace

protected static @NonNull Map<QName,SchemaTreeEffectiveStatement<?>> createSchemaTreeNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)

createDataTreeNamespace

protected static @NonNull ImmutableMap<QName,DataTreeEffectiveStatement<?>> createDataTreeNamespace(Collection<SchemaTreeEffectiveStatement<?>> schemaTreeStatements,
                                                                                                          ImmutableMap<QName,SchemaTreeEffectiveStatement<?>> schemaTreeNamespace)

maskList

protected static final @NonNull Object maskList(ImmutableList<?> list)

Utility method for squashing singleton lists into single objects. This is a CPU/mem trade-off, which we are usually willing to make: for the cost of an instanceof check we can save one object and re-create it when needed. The inverse operation is #unmaskSubstatements(Object)}.

Parameters:

list - list to mask

Returns:

Masked list

Throws:

NullPointerException - if list is null

unmaskList

protected static final <T> @NonNull ImmutableList<T> unmaskList(@NonNull Object masked,
                                                                @NonNull Class<T> type)

Utility method for recovering singleton lists squashed by maskList(ImmutableList).

Parameters:

masked - list to unmask

Returns:

Unmasked list

Throws:

NullPointerException - if any argument is null

ClassCastException - if masked object does not match expected class

maskSet

protected static final @NonNull Object maskSet(ImmutableSet<?> set)

unmaskSet

protected static final <T> @NonNull ImmutableSet<T> unmaskSet(@NonNull Object masked,
                                                              @NonNull Class<T> type)