@Beta public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends AbstractSchemaEffectiveDocumentedNode<String,D> implements Module, NotificationNodeContainerCompat<String,D>
DocumentedNode.WithStatusSchemaTreeAwareEffectiveStatement.Namespace<T extends SchemaTreeEffectiveStatement<?>>| Modifier | Constructor and Description |
|---|---|
protected |
AbstractEffectiveModule(@NonNull StmtContext<String,D,? extends EffectiveStatement<String,?>> ctx,
@NonNull String prefix) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
appendPrefixes(StmtContext<?,?,?> ctx,
ImmutableMap.Builder<String,ModuleEffectiveStatement> builder) |
Optional<DataSchemaNode> |
findDataChildByName(QName name)
Returns the child node corresponding to the specified name.
|
protected static @NonNull String |
findPrefix(@NonNull StmtContext<?,?,?> ctx,
String type,
String name) |
Set<AugmentationSchemaNode> |
getAugmentations()
Returns
AugmentationSchemaNode 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 statement. |
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<TypeDefinition<?>> |
getTypeDefinitions()
Returns set of all newly defined types within this DataNodeContainer.
|
Set<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.
|
String |
toString() |
protected static <T> @NonNull ImmutableList<T> |
unmaskList(@NonNull Object masked,
@NonNull Class<T> type)
Utility method for recovering singleton lists squashed by
maskList(ImmutableList). |
findDataSchemaNode, getNamespaceContentsgetStatus, getUnknownSchemaNodesgetDescription, getReference, nullableDescription, nullableReferenceargument, getDeclared, getStatementSource, statementDefinitionallSubstatementsOfType, effectiveSubstatements, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, initSubstatements, initSubstatementsget, getAll, unmaskListclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetQNameModule, getSubmodulesfindDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByNamegetDescription, getReference, getUnknownSchemaNodesfindNotificationfindSchemaTreeNodeeffectiveSubstatements, findAll, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, get, getAll, getDeclared, streamEffectiveSubstatementsargument, getStatementSource, statementDefinitionprotected AbstractEffectiveModule(@NonNull StmtContext<String,D,? extends EffectiveStatement<String,?>> ctx, @NonNull String prefix)
public URI getNamespace()
Modulenamespace
keyword. If you need both namespace and revision, please consider using Module.getQNameModule().getNamespace in interface ModulegetNamespace in interface NamespaceRevisionAwarepublic String getName()
Modulemodule statement.public Optional<Revision> getRevision()
ModuleModule.getQNameModule().getRevision in interface ModulegetRevision in interface NamespaceRevisionAwarerevison statementpublic String getPrefix()
Modulepublic YangVersion getYangVersion()
ModulegetYangVersion in interface Modulepublic Optional<String> getOrganization()
ModulegetOrganization in interface Moduleorganization statementpublic Optional<String> getContact()
ModuleThe 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.
getContact in interface Modulecontact statementpublic Set<ModuleImport> getImports()
Moduleimport statement.getImports in interface Moduleimport
statements.public Set<FeatureDefinition> getFeatures()
ModuleFeatureDefinition 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.
getFeatures in interface Modulefeature statements.public Set<NotificationDefinition> getNotifications()
NotificationNodeContainerAugmentationSchemaNodes, GroupingDefinitions, ListSchemaNodes and
ContainerSchemaNodes can also contain NotificationDefinitions.getNotifications in interface NotificationNodeContainerpublic Set<AugmentationSchemaNode> getAugmentations()
ModuleAugmentationSchemaNode instances which contain data from augment statements defined
in the module.getAugmentations in interface Moduleaugment
statement and are lexicographically orderedpublic Set<RpcDefinition> getRpcs()
ModuleRpcDefinition instances which contain data from rpc statements defined in the module.public Set<Deviation> getDeviations()
ModuleDeviation instances which contain data from deviation statements defined in the module.getDeviations in interface Modulepublic List<ExtensionDefinition> getExtensionSchemaNodes()
ModuleExtensionDefinition instances which contain data from extension statements defined in
the module.getExtensionSchemaNodes in interface Moduleextension
statements and are lexicographically orderedpublic Set<IdentitySchemaNode> getIdentities()
ModuleIdentitySchemaNode instances which contain data from identity statements defined in the
module.getIdentities in interface Moduleidentity
statements and are lexicographically orderedpublic final Set<TypeDefinition<?>> getTypeDefinitions()
DataNodeContainergetTypeDefinitions in interface DataNodeContainerpublic final Set<DataSchemaNode> getChildNodes()
DataNodeContainer
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.
getChildNodes in interface DataNodeContainerpublic final Set<GroupingDefinition> getGroupings()
DataNodeContainergetGroupings in interface DataNodeContainerpublic final Optional<DataSchemaNode> findDataChildByName(QName name)
DataNodeContainer
Note that the nodes searched are NOT data nodes, but rather DataSchemaNodes,
hence ChoiceSchemaNode and CaseSchemaNode are returned instead of their matching children.
findDataChildByName in interface DataNodeContainername - QName of childpublic Set<UsesNode> getUses()
DataNodeContainergetUses in interface DataNodeContainerpublic Optional<SemVer> getSemanticVersion()
ModulegetSemanticVersion in interface Module(urn:opendaylight:yang:extension:semantic-version?revision=2016-02-02)semantic-version statementprotected static final @NonNull String findPrefix(@NonNull StmtContext<?,?,?> ctx, String type, String name)
protected final void appendPrefixes(StmtContext<?,?,?> ctx, ImmutableMap.Builder<String,ModuleEffectiveStatement> builder)
protected static final @NonNull Object maskList(ImmutableList<?> list)
list - list to maskNullPointerException - if list is nullprotected static final <T> @NonNull ImmutableList<T> unmaskList(@NonNull Object masked, @NonNull Class<T> type)
maskList(ImmutableList).masked - list to unmaskNullPointerException - if any argument is nullClassCastException - if masked object does not match expected classCopyright © 2020 OpenDaylight. All rights reserved.