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

Interface NormalizedMetadata

  • All Superinterfaces:
    org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument>, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>
    @Beta
public interface NormalizedMetadata
extends org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument>, org.opendaylight.yangtools.concepts.Immutable
    RFC7952 metadata counterpart to a NormalizedNode. This interface is meant to be used as a companion to a NormalizedNode instance, hence it does not support iterating over its structure like it is possible with NormalizedNode.getValue(). Children may be inquired through getChildren().

    This model of metadata does not have the RFC7952 restriction on metadata attachment to lists and leaf-lists because NormalizedNode data model has LeafSetNode, MapNode and UnkeyedListNode to which metadata can be attached.

    Author:
    Robert Varga

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @NonNull Map<org.opendaylight.yangtools.yang.common.QName,​Object> getAnnotations()
      Return the set of annotations defined in this metadata node.
      default @NonNull Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument,​NormalizedMetadata> getChildren()
      Returns child nodes.

      • Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

        getIdentifier

    • Method Detail

      • getAnnotations

        @NonNull Map<org.opendaylight.yangtools.yang.common.QName,​Object> getAnnotations()
        Return the set of annotations defined in this metadata node. Values are expected to be effectively-immutable scalar types, like Strings, Numbers and similar. The map must also be effectively-immutable.
        Returns:
        The set of annotations attached to the corresponding data node.

      • getChildren

        default @NonNull Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument,​NormalizedMetadata> getChildren()
        Returns child nodes. Default implementation returns an empty immutable map.
        Returns:
        Child metadata nodes.