Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.tag.set

Interface TagSet

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<TagSet>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TagSet>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<TagSetKey>
@Generated("mdsal-binding-generator") public interface TagSet extends org.opendaylight.yangtools.yang.binding.ChildOf<TagSet>, org.opendaylight.yangtools.yang.binding.Augmentable<TagSet>, org.opendaylight.yangtools.yang.binding.KeyAware<TagSetKey>
Definitions for tag sets

This class represents the following YANG schema fragment defined in module openconfig-routing-policy 

 list tag-set {
   key tag-set-name;
   leaf tag-set-name {
     type string;
   }
   list tag {
     key value;
     leaf value {
       type pt:tag-type;
     }
   }
 }

To create instances of this class use TagSetBuilder.

See Also:

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<TagSet> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • bindingHashCode

      static int bindingHashCode(@NonNull TagSet obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull TagSet thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull TagSet obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • key

      TagSetKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.KeyAware<TagSetKey>

    • getTagSetName

      String getTagSetName()
      Return tagSetName, or null if it is not present. 
           
         name / label of the tag set -- this is used to reference the set in match
         conditions
      Returns:
      String tagSetName, or null if it is not present.

    • requireTagSetName

      default @NonNull String requireTagSetName()
      Return tagSetName, guaranteed to be non-null. 
           
         name / label of the tag set -- this is used to reference the set in match
         conditions
      Returns:
      String tagSetName, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if tagSetName is not present

    • getTag

      @Nullable Map<TagKey,Tag> getTag()
      Return tag, or null if it is not present. 
           
         list of tags that are part of the tag set
      Returns:
      Map<TagKey, Tag> tag, or null if it is not present.

    • nonnullTag

      default @NonNull Map<TagKey,Tag> nonnullTag()
      Return tag, or an empty list if it is not present.
      Returns:
      Map<TagKey, Tag> tag, or an empty list if it is not present.