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

Interface AnnotationSchemaNode

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.model.api.AddedByUsesAware, org.opendaylight.yangtools.yang.model.api.CopyableNode, org.opendaylight.yangtools.yang.model.api.DocumentedNode, org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus, org.opendaylight.yangtools.yang.model.api.EffectiveStatementEquivalent<AnnotationEffectiveStatement>, org.opendaylight.yangtools.yang.model.api.SchemaNode, org.opendaylight.yangtools.yang.model.api.TypeAware, org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode
    @Beta
public interface AnnotationSchemaNode
extends org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode, org.opendaylight.yangtools.yang.model.api.TypeAware, org.opendaylight.yangtools.yang.model.api.EffectiveStatementEquivalent<AnnotationEffectiveStatement>
    Represents the effect of 'annotation' extension, as defined in RFC7952, being attached to a SchemaNode.

    • Nested Class Summary

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

        org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

    • Method Summary

      Static Methods 
      Modifier and Type Method Description
      static @NonNull Optional<AnnotationSchemaNode> find​(org.opendaylight.yangtools.yang.model.api.SchemaContext context, org.opendaylight.yangtools.yang.common.QName qname)
      Find specified annotation if it is supported by the specified SchemaContext.
      static @NonNull Map<org.opendaylight.yangtools.yang.common.QName,​AnnotationSchemaNode> findAll​(org.opendaylight.yangtools.yang.model.api.SchemaContext context)
      Find all annotations supported by a SchemaContext.

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.AddedByUsesAware

        isAddedByUses

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.CopyableNode

        isAugmenting

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

        getDescription, getReference, getUnknownSchemaNodes

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

        getStatus

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.EffectiveStatementEquivalent

        asEffectiveStatement

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.SchemaNode

        getPath, getQName

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.TypeAware

        getType

      • Methods inherited from interface org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode

        getExtensionDefinition, getNodeParameter, getNodeType

    • Method Detail

      • find

        static @NonNull Optional<AnnotationSchemaNode> find​(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                                                    org.opendaylight.yangtools.yang.common.QName qname)
        Find specified annotation if it is supported by the specified SchemaContext.
        Parameters:
        context - SchemaContext to search
        qname - Annotation name
        Returns:
        AnnotationSchemaNode corresponding to specified name, or empty if it is not supported by the SchemaContext..
        Throws:
        NullPointerException - if any of the arguments is null

      • findAll

        static @NonNull Map<org.opendaylight.yangtools.yang.common.QName,​AnnotationSchemaNode> findAll​(org.opendaylight.yangtools.yang.model.api.SchemaContext context)
        Find all annotations supported by a SchemaContext.
        Parameters:
        context - SchemaContext to search
        Returns:
        AnnotationSchemaNodes supported by the SchemaContext..
        Throws:
        NullPointerException - if context is null