Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib

Interface Rib

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Rib>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpRib>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<RibKey>
@Generated("mdsal-binding-generator") public interface Rib extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpRib>, org.opendaylight.yangtools.yang.binding.Augmentable<Rib>, org.opendaylight.yangtools.yang.binding.KeyAware<RibKey>

This class represents the following YANG schema fragment defined in module bgp-rib 

 list rib {
   config false;
   leaf id {
     type rib-id;
   }
   key id;
   list peer {
     key peer-id;
     leaf peer-id {
       type peer-id;
     }
     leaf peer-role {
       type peer-role;
     }
     list supported-tables {
       key "afi safi";
       uses bgp-mp:bgp-add-path-table-type;
     }
     container adj-rib-in {
       uses rib {
         augment tables/attributes {
           leaf llgr-stale {
             type empty;
           }
         }
       }
     }
     container effective-rib-in {
       uses rib;
     }
     container adj-rib-out {
       uses rib;
     }
   }
   container loc-rib {
     uses rib;
   }
 }

To create instances of this class use RibBuilder.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull Rib thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Rib obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Rib obj)
    Default implementation of Object.toString() contract for this interface.
    RibId
    getId()
    Return id, or null if it is not present.
    LocRib
    getLocRib()
    Return locRib, or null if it is not present.
    @Nullable Map<PeerKey,Peer>
    getPeer()
    Return peer, or null if it is not present.
    default Class<Rib>
    implementedInterface()
     
    RibKey
    key()
     
    @NonNull LocRib
    nonnullLocRib()
    Return locRib, or an empty instance if it is not present.
    default @NonNull Map<PeerKey,Peer>
    nonnullPeer()
    Return peer, or an empty list if it is not present.
    default @NonNull RibId
    requireId()
    Return id, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

  • 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<Rib> 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 Rib 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 Rib 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 Rib 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

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

    • getId

      RibId getId()
      Return id, or null if it is not present.
      Returns:
      RibId id, or null if it is not present.

    • requireId

      default @NonNull RibId requireId()
      Return id, guaranteed to be non-null.
      Returns:
      RibId id, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if id is not present

    • getPeer

      @Nullable Map<PeerKey,Peer> getPeer()
      Return peer, or null if it is not present.
      Returns:
      Map<PeerKey, Peer> peer, or null if it is not present.

    • nonnullPeer

      default @NonNull Map<PeerKey,Peer> nonnullPeer()
      Return peer, or an empty list if it is not present.
      Returns:
      Map<PeerKey, Peer> peer, or an empty list if it is not present.

    • getLocRib

      LocRib getLocRib()
      Return locRib, or null if it is not present.
      Returns:
      LocRib locRib, or null if it is not present.

    • nonnullLocRib

      @NonNull LocRib nonnullLocRib()
      Return locRib, or an empty instance if it is not present.
      Returns:
      LocRib locRib, or an empty instance if it is not present.