Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.routers

Interface Router

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Router>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<Routers>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.EntryObject<Router,RouterKey>, org.opendaylight.yangtools.binding.Grouping, org.opendaylight.yangtools.binding.KeyAware<RouterKey>, Peers
@Generated("mdsal-binding-generator") public interface Router extends org.opendaylight.yangtools.binding.ChildOf<Routers>, Peers, org.opendaylight.yangtools.binding.EntryObject<Router,RouterKey>

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

 list router {
   key router-id;
   leaf name {
     type string;
   }
   leaf description {
     type string;
   }
   leaf info {
     type string;
   }
   leaf router-id {
     type router-id;
   }
   leaf status {
     type status;
   }
   uses peers;
 }

To create instances of this class use RouterBuilder.

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<Router> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • bindingHashCode

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

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

    • getName

      String getName()
      Return name, or null if it is not present.
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null.
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getDescription

      String getDescription()
      Return description, or null if it is not present.
      Returns:
      String description, or null if it is not present.

    • requireDescription

      default @NonNull String requireDescription()
      Return description, guaranteed to be non-null.
      Returns:
      String description, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if description is not present

    • getInfo

      String getInfo()
      Return info, or null if it is not present.
      Returns:
      String info, or null if it is not present.

    • requireInfo

      default @NonNull String requireInfo()
      Return info, guaranteed to be non-null.
      Returns:
      String info, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if info is not present

    • getRouterId

      RouterId getRouterId()
      Return routerId, or null if it is not present.
      Returns:
      RouterId routerId, or null if it is not present.

    • requireRouterId

      default @NonNull RouterId requireRouterId()
      Return routerId, guaranteed to be non-null.
      Returns:
      RouterId routerId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if routerId is not present

    • getStatus

      Status getStatus()
      Return status, or null if it is not present.
      Returns:
      Status status, or null if it is not present.

    • requireStatus

      default @NonNull Status requireStatus()
      Return status, guaranteed to be non-null.
      Returns:
      Status status, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if status is not present