Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords

Interface LocatorRecord

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<LocatorRecord>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<LocatorRecords>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<LocatorRecordKey>, RlocContainer
@Generated("mdsal-binding-generator") public interface LocatorRecord extends org.opendaylight.yangtools.yang.binding.ChildOf<LocatorRecords>, org.opendaylight.yangtools.yang.binding.Augmentable<LocatorRecord>, RlocContainer, org.opendaylight.yangtools.yang.binding.Identifiable<LocatorRecordKey>

This class represents the following YANG schema fragment defined in module odl-lisp-proto 

 list LocatorRecord {
   key locator-id;
   ordered-by user;
   leaf locator-id {
     type string;
   }
   leaf priority {
     type uint8;
   }
   leaf weight {
     type uint8;
   }
   leaf multicastPriority {
     type uint8;
   }
   leaf multicastWeight {
     type uint8;
   }
   leaf localLocator {
     type boolean;
   }
   leaf rlocProbed {
     type boolean;
   }
   leaf routed {
     type boolean;
   }
   uses rloc-container;
 }

To create instances of this class use LocatorRecordBuilder.

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 LocatorRecord thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull LocatorRecord obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull LocatorRecord obj)
    Default implementation of Object.toString() contract for this interface.
    Boolean
    getLocalLocator()
    Return localLocator, or null if it is not present.
    String
    getLocatorId()
    Return locatorId, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getMulticastPriority()
    Return multicastPriority, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getMulticastWeight()
    Return multicastWeight, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getPriority()
    Return priority, or null if it is not present.
    Boolean
    getRlocProbed()
    Return rlocProbed, or null if it is not present.
    Boolean
    getRouted()
    Return routed, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getWeight()
    Return weight, or null if it is not present.
    default Class<LocatorRecord>
    implementedInterface()
     
    LocatorRecordKey
    key()
     
    default @NonNull Boolean
    requireLocalLocator()
    Return localLocator, guaranteed to be non-null.
    default @NonNull String
    requireLocatorId()
    Return locatorId, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireMulticastPriority()
    Return multicastPriority, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireMulticastWeight()
    Return multicastWeight, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requirePriority()
    Return priority, guaranteed to be non-null.
    default @NonNull Boolean
    requireRlocProbed()
    Return rlocProbed, guaranteed to be non-null.
    default @NonNull Boolean
    requireRouted()
    Return routed, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireWeight()
    Return weight, guaranteed to be non-null.

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

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RlocContainer

    getRloc

  • 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<LocatorRecord> 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 RlocContainer

    • bindingHashCode

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

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

    • getLocatorId

      String getLocatorId()
      Return locatorId, or null if it is not present.
      Returns:
      String locatorId, or null if it is not present.

    • requireLocatorId

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

    • getPriority

      org.opendaylight.yangtools.yang.common.Uint8 getPriority()
      Return priority, or null if it is not present.
      Returns:
      Uint8 priority, or null if it is not present.

    • requirePriority

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requirePriority()
      Return priority, guaranteed to be non-null.
      Returns:
      Uint8 priority, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if priority is not present

    • getWeight

      org.opendaylight.yangtools.yang.common.Uint8 getWeight()
      Return weight, or null if it is not present.
      Returns:
      Uint8 weight, or null if it is not present.

    • requireWeight

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireWeight()
      Return weight, guaranteed to be non-null.
      Returns:
      Uint8 weight, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if weight is not present

    • getMulticastPriority

      org.opendaylight.yangtools.yang.common.Uint8 getMulticastPriority()
      Return multicastPriority, or null if it is not present.
      Returns:
      Uint8 multicastPriority, or null if it is not present.

    • requireMulticastPriority

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireMulticastPriority()
      Return multicastPriority, guaranteed to be non-null.
      Returns:
      Uint8 multicastPriority, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if multicastPriority is not present

    • getMulticastWeight

      org.opendaylight.yangtools.yang.common.Uint8 getMulticastWeight()
      Return multicastWeight, or null if it is not present.
      Returns:
      Uint8 multicastWeight, or null if it is not present.

    • requireMulticastWeight

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireMulticastWeight()
      Return multicastWeight, guaranteed to be non-null.
      Returns:
      Uint8 multicastWeight, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if multicastWeight is not present

    • getLocalLocator

      Boolean getLocalLocator()
      Return localLocator, or null if it is not present.
      Returns:
      Boolean localLocator, or null if it is not present.

    • requireLocalLocator

      default @NonNull Boolean requireLocalLocator()
      Return localLocator, guaranteed to be non-null.
      Returns:
      Boolean localLocator, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localLocator is not present

    • getRlocProbed

      Boolean getRlocProbed()
      Return rlocProbed, or null if it is not present.
      Returns:
      Boolean rlocProbed, or null if it is not present.

    • requireRlocProbed

      default @NonNull Boolean requireRlocProbed()
      Return rlocProbed, guaranteed to be non-null.
      Returns:
      Boolean rlocProbed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rlocProbed is not present

    • getRouted

      Boolean getRouted()
      Return routed, or null if it is not present.
      Returns:
      Boolean routed, or null if it is not present.

    • requireRouted

      default @NonNull Boolean requireRouted()
      Return routed, guaranteed to be non-null.
      Returns:
      Boolean routed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if routed is not present