Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.header

Interface PeerHeader

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

This class represents the following YANG schema fragment defined in module bmp-message 

 container peer-header {
   uses peer;
   uses timestamp;
   leaf adj-rib-in-type {
     type adj-rib-in-type;
   }
   leaf ipv4 {
     type boolean;
   }
 }

To create instances of this class use PeerHeaderBuilder.

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<PeerHeader> 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
      Specified by:
      implementedInterface in interface Peer
      Specified by:
      implementedInterface in interface Timestamp

    • bindingHashCode

      static int bindingHashCode(@NonNull PeerHeader 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 PeerHeader 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 PeerHeader 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

    • getAdjRibInType

      AdjRibInType getAdjRibInType()
      Return adjRibInType, or null if it is not present.
      Returns:
      AdjRibInType adjRibInType, or null if it is not present.

    • requireAdjRibInType

      default @NonNull AdjRibInType requireAdjRibInType()
      Return adjRibInType, guaranteed to be non-null.
      Returns:
      AdjRibInType adjRibInType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if adjRibInType is not present

    • getIpv4

      Boolean getIpv4()
      Return ipv4, or null if it is not present. 
           
         Indicates if peer's address is IPv4. If set to false address is IPv6.
      Returns:
      Boolean ipv4, or null if it is not present.

    • requireIpv4

      default @NonNull Boolean requireIpv4()
      Return ipv4, guaranteed to be non-null. 
           
         Indicates if peer's address is IPv4. If set to false address is IPv6.
      Returns:
      Boolean ipv4, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipv4 is not present