Package org.opendaylight.yangtools.yang.model.api

Interface ModuleLike

All Superinterfaces:
DataNodeContainer, DocumentedNode, Immutable, NotificationNodeContainer, QNameModuleAware
All Known Subinterfaces:
Module, Submodule
All Known Implementing Classes:
AbstractEffectiveModule
@Beta public interface ModuleLike extends DataNodeContainer, DocumentedNode, Immutable, NotificationNodeContainer, QNameModuleAware
This interface contains common methods for getting the schema contents from a YANG module or submodule.

  • Method Details

    • getName

      String getName()
      Returns the name of the module which is specified as argument of YANG module statement.
      Returns:
      string with the name of the module

    • getPrefix

      String getPrefix()
      Returns the prefix of the module.
      Returns:
      string with the module prefix which is specified as argument of YANG prefix statement

    • getYangVersion

      YangVersion getYangVersion()
      Returns the YANG version.
      Returns:
      YANG version of this module.

    • getOrganization

      Optional<String> getOrganization()
      Returns the module organization.
      Returns:
      string with the name of the organization specified in the module as the argument of YANG organization statement

    • getContact

      Optional<String> getContact()
      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.

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

    • getImports

      Collection<? extends @NonNull ModuleImport> getImports()
      Returns imports which represents YANG modules which are imported to this module via import statement.
      Returns:
      set of module imports which are specified in the module as the argument of YANG import statements.

    • getSubmodules

      Collection<? extends @NonNull Submodule> getSubmodules()

    • getFeatures

      Collection<? extends @NonNull FeatureDefinition> getFeatures()
      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.

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

    • getAugmentations

      Collection<? extends @NonNull AugmentationSchemaNode> getAugmentations()
      Returns AugmentationSchemaNode instances which contain data from augment statements defined in the module.
      Returns:
      set of the augmentation schema instances which are specified in the module as YANG augment statement and are lexicographically ordered

    • getRpcs

      Collection<? extends @NonNull RpcDefinition> getRpcs()
      Returns RpcDefinition instances which contain data from rpc statements defined in the module.
      Returns:
      set of the RPC definition instances which are specified in the module as YANG rpc statements and are lexicographicaly ordered

    • getDeviations

      Collection<? extends @NonNull Deviation> getDeviations()
      Returns Deviation instances which contain data from deviation statements defined in the module.
      Returns:
      set of the deviation instances

    • getIdentities

      Collection<? extends @NonNull IdentitySchemaNode> getIdentities()
      Returns IdentitySchemaNode instances which contain data from identity statements defined in the module.
      Returns:
      set of identity schema node instances which are specified in the module as YANG identity statements and are lexicographically ordered

    • getExtensionSchemaNodes

      Collection<? extends @NonNull ExtensionDefinition> getExtensionSchemaNodes()
      Returns ExtensionDefinition instances which contain data from extension statements defined in the module.
      Returns:
      set of extension definition instances which are specified in the module as YANG extension statements and are lexicographically ordered