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

Interface SchemaContext

    • Field Detail

      • NAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName NAME
        QName of NETCONF top-level data node.

    • Method Detail

      • getDataDefinitions

        @NonNull Collection<? extends @NonNull DataSchemaNode> getDataDefinitions()
        Returns data schema node instances which represents direct subnodes (like leaf, leaf-list, list, container) in all YANG modules in the context.
        Returns:
        set of DataSchemaNode instances which represents YANG data nodes at the module top level

      • getModules

        @NonNull Collection<? extends @NonNull Module> getModules()
        Returns modules which are part of the schema context. Returned set is required to have its iteration ordered by module revision, so that if modules are filtered by ModuleLike.getName() or QNameModuleAware.getNamespace(), modules having the same attribute are encountered newest revision first.
        Returns:
        set of the modules which belong to the schema context

      • getOperations

        @NonNull Collection<? extends @NonNull RpcDefinition> getOperations()
        Returns rpc definition instances which are defined as the direct subelements in all YANG modules in the context.
        Returns:
        set of RpcDefinition instances which represents nodes defined via rpc YANG keyword

      • getExtensions

        @NonNull Collection<? extends ExtensionDefinition> getExtensions()
        Returns extension definition instances which are defined as the direct subelements in all YANG modules in the context.
        Returns:
        set of ExtensionDefinition instances which represents nodes defined via extension YANG keyword

      • findModule

        Optional<Module> findModule​(@NonNull org.opendaylight.yangtools.yang.common.QNameModule qnameModule)
        Returns the module matching specified QNameModule, if present.
        Parameters:
        qnameModule - requested QNameModule
        Returns:
        Module, if present.
        Throws:
        NullPointerException - if qnameModule is null

      • findModule

        default Optional<Module> findModule​(@NonNull org.opendaylight.yangtools.yang.common.XMLNamespace namespace)
        Returns module instance (from the context) with specified namespace and no revision.
        Parameters:
        namespace - module namespace
        Returns:
        module instance which has name and revision the same as are the values specified in parameters namespace and no revision.

      • findModule

        default Optional<Module> findModule​(@NonNull org.opendaylight.yangtools.yang.common.XMLNamespace namespace,
                                    @Nullable org.opendaylight.yangtools.yang.common.Revision revision)
        Returns module instance (from the context) with specified namespace and revision.
        Parameters:
        namespace - module namespace
        revision - module revision, may be null
        Returns:
        module instance which has name and revision the same as are the values specified in parameters namespace and revision.

      • findModule

        default Optional<Module> findModule​(@NonNull org.opendaylight.yangtools.yang.common.XMLNamespace namespace,
                                    @NonNull Optional<org.opendaylight.yangtools.yang.common.Revision> revision)
        Returns module instance (from the context) with specified namespace and revision.
        Parameters:
        namespace - module namespace
        revision - module revision, may be null
        Returns:
        module instance which has name and revision the same as are the values specified in parameters namespace and revision.

      • findModule

        default Optional<? extends Module> findModule​(String name,
                                              Optional<org.opendaylight.yangtools.yang.common.Revision> revision)
        Returns module instance (from the context) with specified name and an optional revision.
        Parameters:
        name - string with the module name
        revision - date of the module revision
        Returns:
        module instance which has name and revision the same as are the values specified in parameters name and revision.

      • findModule

        default Optional<? extends Module> findModule​(String name,
                                              @Nullable org.opendaylight.yangtools.yang.common.Revision revision)
        Returns module instance (from the context) with specified name and revision.
        Parameters:
        name - string with the module name
        revision - date of the module revision, may be null
        Returns:
        module instance which has name and revision the same as are the values specified in parameters name and revision.

      • findModule

        default Optional<? extends Module> findModule​(String name)
        Returns module instance (from the context) with specified name and no revision.
        Parameters:
        name - string with the module name
        Returns:
        module instance which has name and revision the same as are the values specified in name and no revision.
        Throws:
        NullPointerException - if name is null

      • findModules

        default @NonNull Collection<? extends @NonNull Module> findModules​(String name)
        Returns module instances (from the context) with a concrete name. Returned Set is required to have its iteration order guarantee that the latest revision is encountered first.
        Parameters:
        name - string with the module name
        Returns:
        set of module instances with specified name.

      • findModules

        default @NonNull Collection<? extends @NonNull Module> findModules​(org.opendaylight.yangtools.yang.common.XMLNamespace namespace)
        Returns module instance (from the context) with concrete namespace. Returned Set is required to have its iteration order guarantee that the latest revision is encountered first.
        Parameters:
        namespace - XMLNamespace instance with specified namespace
        Returns:
        module instance which has namespace equal to the namespace or null in other cases

      • getDescription

        @Deprecated
default Optional<String> getDescription()
        Deprecated.
        Description copied from interface: DocumentedNode
        Returns the value of the argument of YANG description keyword.
        Specified by:
        getDescription in interface DocumentedNode
        Returns:
        string with the description, or empty if description was not provided.

      • getReference

        @Deprecated
default Optional<String> getReference()
        Deprecated.
        Description copied from interface: DocumentedNode
        Returns the value of the argument of YANG reference keyword.
        Specified by:
        getReference in interface DocumentedNode
        Returns:
        string with reference to some other document, or empty if reference was not provided.

      • getWhenCondition

        @Deprecated
default Optional<? extends org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound> getWhenCondition()
        Deprecated.
        Description copied from interface: WhenConditionAware
        Returns when statement.

        If when condition is present node defined by the parent data definition statement is only valid when the returned XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.

        Specified by:
        getWhenCondition in interface WhenConditionAware
        Returns:
        XPath condition

      • isAugmenting

        @Deprecated
default boolean isAugmenting()
        Deprecated.
        Description copied from interface: CopyableNode
        Returns true if this node was added by augmentation, otherwise returns false.
        Specified by:
        isAugmenting in interface CopyableNode
        Returns:
        true if this node was added by augmentation, otherwise returns false

      • isAddedByUses

        @Deprecated
default boolean isAddedByUses()
        Deprecated.
        Description copied from interface: AddedByUsesAware
        Returns true if this node was added by uses statement, otherwise returns false.
        Specified by:
        isAddedByUses in interface AddedByUsesAware
        Returns:
        true if this node was added by uses statement, otherwise returns false

      • getQName

        @Deprecated
default org.opendaylight.yangtools.yang.common.QName getQName()
        Deprecated.
        Description copied from interface: SchemaNode
        Returns QName of the instance of the type SchemaNode.
        Specified by:
        getQName in interface SchemaNode
        Returns:
        QName with the name of the schema node