Class AbstractEffectiveModule<D extends DeclaredStatement<String>>

    • 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 statement.
        Specified by:
        getName in interface Module
        Returns:
        string with the name of the module
      • 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 statement
      • 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 statement
      • 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 statement
      • 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 statements.
      • 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 statements.
      • getAugmentations

        public Set<AugmentationSchemaNode> getAugmentations()
        Description copied from interface: Module
        Returns AugmentationSchemaNode 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 statement 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 statements 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 statements 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 statements and are lexicographically ordered
      • 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
      • 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